Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation headings #118

Open
twynb opened this issue Sep 24, 2023 · 0 comments
Open

documentation headings #118

twynb opened this issue Sep 24, 2023 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@twynb
Copy link
Owner

twynb commented Sep 24, 2023

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)

@twynb twynb added bug Something isn't working documentation Improvements or additions to documentation labels Sep 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant