Skip to content

Add workaround of missing toc index in sphinx < 5.2 #211

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add workaround of missing toc index in sphinx < 5.2 #211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 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 @@ -547,6 +547,21 @@ def build(self, *, doc_build_folder, output_staging_directory):
os.makedirs(wrapped_sphinx_directory, exist_ok=True)
Path(wrapped_sphinx_directory).joinpath('COLCON_IGNORE').touch()

# In versions of Sphinx prior to 5.2, it is challenging to create a toc link to
# the index. This workaround overcomes that.
# See https://stackoverflow.com/questions/40556423/
# how-can-i-link-the-generated-index-page-in-readthedocs-navigation-bar
# Remove when we no longer support Sphinx < 5.2,
# that is when humble is no longer supported.
GENINDEX = """
.. This file is a placeholder and will be replaced

Index
#####
"""
with open(os.path.join(wrapped_sphinx_directory, 'genindex.rst'), 'w+') as f:
f.write(GENINDEX)

# Generate rst documents for interfaces
interface_counts = generate_interface_docs(
package_xml_directory,
Expand Down