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

Inconsistent sphinx heading levels in docs #2472

Closed
maxnoe opened this issue Nov 24, 2023 · 1 comment · Fixed by #2474
Closed

Inconsistent sphinx heading levels in docs #2472

maxnoe opened this issue Nov 24, 2023 · 1 comment · Fixed by #2474
Labels

Comments

@maxnoe
Copy link
Member

maxnoe commented Nov 24, 2023

Describe the bug

We have a relatively wild mix of heading levels in the documentation pages.

To Reproduce

Look at the docs code.

Expected behavior

Be consisntent

Supporting information

Definition of heading levels in sphinx rst:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections

@maxnoe maxnoe added the bug label Nov 24, 2023
@maxnoe
Copy link
Member Author

maxnoe commented Nov 24, 2023

@aknierim Could you have a look?

maxnoe added a commit that referenced this issue Nov 28, 2023
Docs: Fix Headings in Docs [Closes #2472]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant