Skip to content

Commit

Permalink
Adjusted documentation around toctree editing
Browse files Browse the repository at this point in the history
  • Loading branch information
AWhetter committed Mar 28, 2023
1 parent 6b16e02 commit f440803
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Removed the option to have autoapi generate toctree entries for domain objects.
Domain objects are now added to the toctree by Sphinx.
Dropped support for sphinx < 5.2.0.
6 changes: 0 additions & 6 deletions docs/reference/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,6 @@ Customisation Options
and you will need to include the generated documentation
in a TOC tree entry yourself.

.. confval:: autoapi_add_objects_to_toctree

Default: ``True``

Whether to insert a TOC tree entry for each object (class, function, etc.).

.. confval:: autoapi_python_class_content

Default: ``class``
Expand Down

0 comments on commit f440803

Please sign in to comment.