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.

Sign up for GitHub

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

Fix toctree warnings and render toctree in the HTML sidebar #20

Merged
merged 2 commits into from
Jul 29, 2021
Merged

Fix toctree warnings and render toctree in the HTML sidebar #20

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2936f2
Add library API to the toctree
Jul 23, 2021
5f82cbc
Removing `README` listing from the index `toctree`
Jul 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions rosdoc2/verbs/build/builders/sphinx_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,15 @@ def ensure_global(name, default):
## without the rosdoc2 tool.
html_theme = 'sphinx_rtd_theme'

html_theme_options = {{
# Toc options
'collapse_navigation': False,
'sticky_navigation': True,
'navigation_depth': -1,
'includehidden': True,
'titles_only': False,
}}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down Expand Up @@ -216,9 +225,13 @@ def ensure_global(name, default):
C++ API
=======

:doc:`api/library_root`
.. toctree::
:maxdepth: 2

.. doxygenindex::
README <api/program_listing_file_README.md.rst>
aprotyas marked this conversation as resolved.
Show resolved Hide resolved
api/library_root
Full API <api/unabridged_api>
File structure <api/unabridged_orphan>

Indices and Search
==================
Expand Down