Differential D6489

docs, user: Fix faq menu rendering glitch
ClosedPublic
Actions

Authored by anlambert on Oct 15 2021, 4:47 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3657: Fix faq menu rendering glitch in docs.s.o

Commits

rDDOC788598eb8eb6: docs, user: Fix faq menu rendering glitch

Summary

As the toctree for the faq was included multiple times in index file,
the associated menu entry in the sidebar was not properly rendered.

In order to workaround the issue, ensure faq toctree is included once
in the index file and use references to faq sections instead in
documentation main page.

Also as faq subsection entries are no longer included in the sidebar
menu, display a local toctree at the top of the faq page.

Closes T3657

Diff Detail

Repository

rDDOC Development documentation

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Oct 15 2021, 4:47 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptOct 15 2021, 4:47 PM

anlambert requested review of this revision.Oct 15 2021, 4:47 PM

Harbormaster completed remote builds in B24474: Diff 23574.Oct 15 2021, 4:47 PM

ardumont accepted this revision.Oct 15 2021, 5:04 PM

ardumont added a subscriber: ardumont.

ardumont added inline comments.

docs/index.rst
59	I had something like that locally but that saddens me to duplicate entries already present in the faq/index.. I don't see anything better so ok ;) Thanks.

This revision is now accepted and ready to land.Oct 15 2021, 5:04 PM

anlambert added inline comments.Oct 15 2021, 5:07 PM

docs/index.rst
59	I did not find a better solution. We could also simply link to the faq page to avoid duplicating the toctree by hand but then we will have FAQ => FAQ which is also not great.