Reference

The reference section collects generated artifacts and registry helpers that complement the conceptual guides. To produce these references tools/gen_model_docs.py should be run manually.

Built-in models

The reference/models subfolder is populated by tools/gen_model_docs.py via mkdocs-gen-files. Each model under src/dynlib/models/{map,ode} gets a dedicated page showing the TOML source plus links into the literate navigation tree (reference/models/SUMMARY.md).

• Built-in model overview — choose between the map and ODE collections and open any generated TOML listing.

Generating docs locally

• The documentation relies on mkdocs. To regenerate or serve the documentation locally:

• Install MkDocs and required plugins:

  pip install mkdocs mkdocs-material mkdocs-literate-nav "mkdocstrings[python]" mkdocs-static-i18n
  

• Install additional Markdown extensions:

  pip install pymdown-extensions
  

• From the project root, serve the docs:

  mkdocs serve
  

  Or build them:

  mkdocs build
  

• To manually update the auto-generated doc files run:

  python tools/gen_model_docs.py
  

The generated site will be in the site/ directory.