Add config option for adding :toctree: on autosummary lists. #6
Conversation
This file contains hidden or 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
IPython uses some lists of class attributes and methods, but we don't generate separate doc pages for each entry, so Sphinx throws warnings about "toctree contains reference to nonexisting document". This adds a Sphinx option called 'numpydoc_class_members_toctree', defaulting to True, controlling whether the autosummary lists are generated with the :toctree: option. Setting it to False suppresses these warnings, but prevents the lists acting as tables of contents. Addresses issue numpygh-5.
takluyver
added a commit
to takluyver/ipython
that referenced
this pull request
Jan 6, 2014
The second is a new option that my PR numpy/numpydoc#6 adds, so we should wait until that is merged to merge this.
takluyver
added a commit
to takluyver/ipython
that referenced
this pull request
Jan 6, 2014
The second is a new option that my PR numpy/numpydoc#6 adds, so we should wait until that is merged to merge this.
|
Should also be mentioned in the README |
|
Thanks, I felt like it should be documented somewhere, I just hadn't seen that. Done. :-) |
pv
added a commit
that referenced
this pull request
Jan 7, 2014
Add config option for adding :toctree: on autosummary lists.
|
Thanks, LGTM |
mattvonrocketstein
pushed a commit
to mattvonrocketstein/ipython
that referenced
this pull request
Nov 3, 2014
The second is a new option that my PR numpy/numpydoc#6 adds, so we should wait until that is merged to merge this.
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
IPython uses some lists of class attributes and methods, but we don't generate separate doc pages for each entry, so Sphinx throws warnings about "toctree contains reference to nonexisting document".
This adds a Sphinx option called
numpydoc_class_members_toctree, defaulting to True, controlling whether the autosummary lists are generated with the :toctree: option. Setting it to False suppresses these warnings, but prevents the lists acting as tables of contents.Addresses issue gh-5.