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

Doc: fix for topical navigation #12288

Merged
merged 2 commits into from
Sep 25, 2023
Merged

Conversation

ru-fu
Copy link
Contributor

@ru-fu ru-fu commented Sep 21, 2023

Instead of using the Sphinx "only" directive in an unsupported way
to create to different navigation structures, use a "filtered-toc"
extension that actually supports this.

@github-actions github-actions bot added the Documentation Documentation needs updating label Sep 21, 2023
@ru-fu ru-fu force-pushed the LXD-434-navigation-fix branch from 9c69b9c to 9ffbeb9 Compare September 21, 2023 15:17
Instead of using the Sphinx "only" directive in an unsupported way
to create to different navigation structures, use a "filtered-toc"
extension that actually supports this.
Update the existing navigation to use this new feature.
This also allows us to use the same index page for both navigations.

Signed-off-by: Ruth Fuchss <[email protected]>
The new extension works with any Sphinx version, so no need to keep
the version pinned.

Signed-off-by: Ruth Fuchss <[email protected]>
@ru-fu ru-fu force-pushed the LXD-434-navigation-fix branch from 9ffbeb9 to 1c57a8b Compare September 22, 2023 15:47
@ru-fu ru-fu marked this pull request as ready for review September 25, 2023 08:45
@ru-fu ru-fu requested a review from tomponline as a code owner September 25, 2023 08:45
@tomponline tomponline merged commit 4eb5fb2 into canonical:main Sep 25, 2023
@ru-fu ru-fu deleted the LXD-434-navigation-fix branch September 26, 2023 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants