-
-
Notifications
You must be signed in to change notification settings - Fork 171
Open
Description
I am not sure of the interactions between all the pieces, but here my understanding:
- numpy has a
class.rsttemplate that extends the one in sphinx's autosummary extension. It adds atoctreeoption to a nestedautosummarydirective (nested under aHACKdirective) - During the parse phase, sphinx adds the
toctreecontents to the documentation, since this is all done with regex and it doesn't care there are nested directives - Since sphinx ignores nested directives during output processing, the
toctreeis not generated - As far as sphinx is concerned, the generated documents are not in any
toctree, so we added anorphantag to them in additional templates in numpy to avoid a warning.
So why do we need the toctree in the template in the first place? Removing the numpy class.rst seems to produce problematic documentation. Is this a numpydoc or sphinx problem or just a feature?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels