ABLE Workflow copier template documentation¶
Overview¶
The documentation for this project uses MkDocs and the Material for MkDocs theme.
The documentation source files are located in the docs/docs/ directory.
Serving the documentation locally¶
The following assumes that you have already set up the development environment.
Serving just the able-workflow-copier docs¶
Serving ALL the able-workflow docs¶
The following assumes that you cloned all the submodules in this repo
Logs for the local mkdocs servers for each of these processes can be found in logs/mkdocs_serve_all/
Tools and tips for writing documentation¶
Admonitions¶
How to add note, info, tips, etc. blocks (and collapsable blocks).
like this
Info block that can collapse away.
MathJax¶
Write equations with latex and mathjax.
mathjax example
When \(a \ne 0\), there are two solutions to \(ax^2 + bx + c = 0\) and they are
mkdocs include markdown¶
mkdocs literate nav¶
The navigation structure is specified with
literate-nav in the
SUMMARY.md file within the docs/docs/ directory and each subdirectory.
mkdocs macros¶
mkdocstrings¶
All python code should contain type hints and numpy-style docstring. These are rendered into the documentation using mkdocstrings.