Skip to content
Snippets Groups Projects
Commit 788598eb authored by Antoine Lambert's avatar Antoine Lambert
Browse files

docs, user: Fix faq menu rendering glitch

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 add reference to faq page in Getting started
top level section.

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
parent 50375fc1
No related branches found
No related tags found
1 merge request!171docs, user: Fix faq menu rendering glitch
......@@ -3,6 +3,11 @@
Frequently Asked Questions
**************************
.. contents::
:depth: 3
:local:
..
.. _faq_prerequisites:
Prerequisites for code contributions
......
......@@ -10,6 +10,7 @@ Getting started
software stack in less than 5 minutes, or
* :ref:`developer-setup` → get a working development setup that allows to hack
on the Software Heritage software stack
* :ref:`faq`
Contributing
------------
......@@ -49,14 +50,6 @@ Tutorials
* :ref:`Add a new swh package <tutorial-new-package>`
* :ref:`doc-contribution`
Frequently Asked Questions
--------------------------
.. toctree::
:maxdepth: 2
faq/index
Roadmap
-------
......
......@@ -3,6 +3,11 @@
Frequently Asked Questions
**************************
.. contents::
:depth: 3
:local:
..
.. _faq_roadmap:
Roadmap
......
......@@ -10,22 +10,13 @@ Software Heritage User documentation
Getting started
---------------
...
* :ref:`faq`
Tutorials
---------
...
Frequently Asked Questions
---------------------------
.. toctree::
:maxdepth: 2
faq/index
Indices and tables
==================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment