Documentation¶
Documentation is built with Zensical and
configured in zensical.toml. API reference pages are auto-generated
from NumPy-style docstrings via mkdocstrings.
Build¶
Serve locally¶
The server is available at http://localhost:8001/owi-metadatabase-sdk/.
Structure¶
The documentation follows the Diátaxis framework:
| Section | Purpose | Directory |
|---|---|---|
| Tutorials | Learning-oriented lessons | docs/tutorials/ |
| How-to guides | Problem-oriented recipes | docs/how-to/ |
| Reference | Information-oriented descriptions | docs/reference/ |
| Explanation | Understanding-oriented discussions | docs/explanation/ |