Skip to content

docs: generate index and add it to globaltoc sidebar #6808

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

Merged
merged 3 commits into from
Feb 26, 2020
Merged

docs: generate index and add it to globaltoc sidebar #6808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fa07ca
docs: generate index
blueyed Feb 24, 2020
2cac52b
docs: add genindex to globaltoc
blueyed Feb 24, 2020
98dd51d
rebuild
blueyed Feb 24, 2020
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
4 changes: 4 additions & 0 deletions doc/en/_templates/globaltoc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
<hr>
{{ toc }}
{%- endif %}

<hr>
<a href="{{ pathto('genindex') }}">Index</a>
<hr>
2 changes: 1 addition & 1 deletion doc/en/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@
html_domain_indices = True

# If false, no index is generated.
html_use_index = False
html_use_index = True

# If true, the index is split into individual pages for each letter.
# html_split_index = False
Expand Down