-
Notifications
You must be signed in to change notification settings - Fork 0
documentation headings #118
Copy link
Copy link
Open
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Activity
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation
Sphinx' docs contain links that point to specific headings in the files they link to. These links work after #117 , but don't lead to the actual heading in the link tag because the headings have further formatting in them.
Classes have an additional "
*class*" before the actual class name the link tries to point to, functions have their parameters in the heading, which the link doesn't include.For example, the generated
backend_modules.mdpoints tobackend_modules_api_service#backend.modules.api_service.ApiService, the actual heading it tries to point to is formatted as*class* backend.modules.api_service.ApiServicethough.Functions have a similar issue.
backend_modules.mdpoints tobackend_modules_api_service#backend.modules.api_service.submit_to_services, the actual heading isbackend.modules.api_service.submit_to_services(file_name, metadata)