simtools-docs-generate-toctree

Generate Sphinx toctree index files for the simulation model documentation.

Writes an index.md file with a toctree into each directory of the documentation source tree listing its markdown reports, images, and subdirectories. An index containing <!-- simtools: keep-index --> is preserved so site-owned pages can define their layout. Directories for static content, images, data files, and build output are ignored.

Writes index.md files with Sphinx toctrees into the documentation source tree given by --docs_path, listing the generated reports of each directory.

Example

simtools-docs-generate-toctree --docs_path docs

Command line arguments

options

–help

show this help message and exit

–docs_path

Root directory of the Sphinx documentation source.

Required.

application

–show_options

Print available values for a supported option and exit.

Example

Generate toctree index files for generated reports

Write index.md files with Sphinx toctrees into a documentation source tree containing generated simulation model reports.

Application: simtools-docs-generate-toctree

Integration test: docs_generate_toctree_run.yml

Command

simtools-docs-generate-toctree --config tests/integration_tests/config/docs_generate_toctree_run.yml

Configuration

docs_path: docs