Skip to content

documentation headings #118

@twynb

Description

@twynb

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.md points to backend_modules_api_service#backend.modules.api_service.ApiService, the actual heading it tries to point to is formatted as *class* backend.modules.api_service.ApiService though.

Functions have a similar issue. backend_modules.md points to backend_modules_api_service#backend.modules.api_service.submit_to_services, the actual heading is backend.modules.api_service.submit_to_services(file_name, metadata)

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions