iperflexer.infrastructure.index_builder.subfolder_toctree

iperflexer.infrastructure.index_builder.subfolder_toctree(maxdepth=1, subfolders=None, add_headers=False)[source]

Creates the toctree for sub-folder indices

Param:
  • maxdepth: Level of sub-headings to include
  • subfolders: iterable of sub-folders with index.rst
  • add_headers: True- use folder names as separators