You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
AutoAPI will automatically add itself to the last TOCTree in your top-level index.rst.
...
We hope to be able to dynamically add items into the TOCTree, and remove this step. However, it is currently required.
I don't really know what this means but it sounds like it would mean implementing a similar thing?
The text was updated successfully, but these errors were encountered:
AWhetter
changed the title
Allow the toctree node the entries are placed under to be configurable
Allow which node the toctree node entries are placed under to be configurable
Jun 12, 2017
AWhetter
changed the title
Allow which node the toctree node entries are placed under to be configurable
Allow which toctree node the entries are placed under to be configurable
Jun 12, 2017
Closing because I think it makes more sense for a user to set autoapi_add_toctree_entry to False and then add a toctree entry for /autoapi/index.rst wherever they want autoapi included.
We ever go as far as to put /autoapi/<my_package>/index.rst in our toctree so that we don't get the top level autoapi index file.
@AWhetter I tried your suggested solution and it didn't work (autoapi_add_toctree_entry = False and then adding /autoapi/index.rst to the specific toctree directive where I wanted to add it.
To be more specific, with autoapi_add_toctree_entry = False, then I get the error WARNING: toctree contains reference to nonexisting document 'autoapi/index'
One workaround is to then set autoapi_root and then reference path/project/index in a TOC, but this then means the sidebar entry is just the package name, rather than API reference, which is preferred.
It would be nice to be able to configure which toctree node autoapi adds itself to. Currently this is hardcoded to
"index"
(https://github.com/rtfd/sphinx-autoapi/blob/5529237fb5012039d248abccdf61865aace5fb32/autoapi/extension.py#L117).For example I have the case where my documentation is split into a user and technical section. I want the API docs to reside under the technical section rather than at the top level.
The README says
I don't really know what this means but it sounds like it would mean implementing a similar thing?
The text was updated successfully, but these errors were encountered: