Compatibility with autosummary toctree option?
See original GitHub issueI’m currently using jupyter-book
and sphinx.ext.autosummary
(with great success!). I’m also trying to use the :toctree:
option in autosummary to let the table serve as a toctree, and so that sphinx-autogen
will generate stub files for each item in the tree. It’s actually working great and i get the desired result (which is an autogenerated “subtree” extension of my _toc.yml
based on the class names in a given module).
```{eval-rst}
.. autosummary::
:toctree: _autosummary
item_a
item_b
```
The only niggle I’m running into at the moment is a slew of warnings in my build logs for all of stubs created by jupyter-book
:
WARNING: Found a content page that is not in _toc.yml: _autosummary/_______.rst
best I can tell, it’s because these these autogenerated stubs aren’t getting injected into app.config["globaltoc"]
… but I can’t tell if there’s anything I should be doing to fix it, or if this is a legitimate feature request. (If I add the _autosummary stubs to the exclude_pattern
, the warnings go away, but then so too do the corresponding docs).
Describe the solution you’d like
I’d like to be able to use the sphinx.ext.autosummary
directive with the :toctree:
option without having to manually specify each of the autogenerated *.rst
stub files in my _toc.yml
, and without getting all of the Warnings in my logs.
thanks!
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (2 by maintainers)
Top GitHub Comments
thanks for the feedback @tlambert03 we will try to have a look at some point, it may well be that we have to “special case” these auto-generated files
hm. either way. I kinda like the option of having a warning by default, but an opt-out pattern would be nice.