Skip to content

Conversation

@aidanfnv
Copy link
Contributor

@aidanfnv aidanfnv commented May 2, 2025

Fixes #73

readthedocs treats H1 headings as document titles in the sidebar.
This change turns all extra H1 headings into H2, H2 to H3, etc.

See the Tutorials section at the bottom of the left-hand side bar on the site built from main for the extraneous titles.
See https://shader-slanggithubio-aidanfnv-wip.readthedocs.io/en/fix-readthedocs-headings/ for what the site looks like on this branch.

aidanfnv added 2 commits May 1, 2025 17:01
readthedocs treats H1 headings as document titles in the sidebar.
This change turns all extra H1 headings into H2, H2 to H3, etc.
@aidanfnv aidanfnv marked this pull request as ready for review May 2, 2025 00:06
@aidanfnv aidanfnv changed the title Remove extra H1 headings by making them H2 Remove extra TOC entries by turning H1 headings into H2 May 2, 2025
@aidanfnv aidanfnv requested a review from jkwak-work May 2, 2025 05:38
Copy link
Contributor

@jkwak-work jkwak-work left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@aidanfnv aidanfnv merged commit 198bf65 into shader-slang:main May 2, 2025
@aidanfnv aidanfnv deleted the fix/readthedocs-headings branch May 10, 2025 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

readthedocs navigation sidebar formatted incorrectly for some docs

2 participants