Allow reserved pages in toctree #2849
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Blendify
reviewed
Feb 22, 2022
|
Synced upstream changes and updated code as it was originally from 5.5 years ago. Also updated tests. |
Blendify
approved these changes
Feb 26, 2022
AA-Turner
requested changes
May 23, 2022
| @@ -220,6 +221,9 @@ tables of contents. The ``toctree`` directive is the central element. | |||
| .. versionchanged:: 1.3 | |||
| Added "caption" and "name" option. | |||
|
|
|||
| .. versionchanged:: 4.5 | |||
There was a problem hiding this comment.
Suggested change
| .. versionchanged:: 4.5 | |
| .. versionchanged:: 5.1 |
If you re-target the PR to 5.x
| @@ -124,7 +124,7 @@ def parse_content(self, toctree: addnodes.toctree) -> List[Node]: | |||
| break | |||
| # absolutize filenames | |||
| docname = docname_join(self.env.docname, docname) | |||
| if url_re.match(ref) or ref == 'self': | |||
| if url_re.match(ref) or ref in ('self', 'genindex', 'modindex', 'search'): | |||
There was a problem hiding this comment.
I'd prefer if this 4-tuple was factored out somewhere as it is used more than once, but there aren't any great locations that come to mind.
Comment on lines
+153
to
+154
| the toctree. The special document names ``genindex``, ``modindex``, and | ||
| ``search`` can also be used. |
There was a problem hiding this comment.
Perhaps expand this, as the special names can also be used indirectly, as you illustrate in the test.
|
Closed by #10673 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was looking to add the general index to a toctree and it didn't seem like that was possible, so I created this patch to allow it.
Basically this allows the special document names (genindex, modindex, search) to be used as page names in a toctree either with their default titles or custom ones.
It seems I'm not the only one who was looking for this:
http://stackoverflow.com/questions/36235578/how-can-i-include-the-genindex-in-a-sphinx-toc
http://stackoverflow.com/questions/25243482/how-to-add-sphinx-generated-index-to-the-sidebar-when-using-read-the-docs-theme