Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

autotoctree

class docfly.directives.autotoctree.AutoTocTree(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Automatically includes index.rst in toctree from:

<current_dir>/<any-folder>/index.rst

Any toctree directive arguments are supported.

Example, the content of <current_dir>/index.rst:

.. autodoctree::

Will be converted to:

.. toctree::

    ./section1/index.rst
    ./section2/index.rst
    ...

derive_toctree_rst(current_file)

Generate the rst content:

.. toctree::
    args ...

    example.rst
    ...

Parameters

current_file –

Returns