edits
This commit is contained in:
@@ -28,13 +28,17 @@ Primary docs:
|
||||
## Minimal Integration Pattern
|
||||
|
||||
1. Add mkdocstrings and a Python handler package to project dependencies.
|
||||
2. Configure docs toolchain to enable mkdocstrings plugin/extension.
|
||||
2. Configure the Zensical docs toolchain to enable mkdocstrings within the site build.
|
||||
3. Create one API index page per package/domain.
|
||||
4. Expand coverage gradually from high-value modules first.
|
||||
|
||||
General reference examples:
|
||||
- Plugin docs: https://www.mkdocs.org/user-guide/plugins/
|
||||
- Material + code/reference setup concepts: https://squidfunk.github.io/mkdocs-material/reference/
|
||||
- Zensical docs home and setup entry point: https://zensical.org/docs/
|
||||
- Zensical code blocks and authoring patterns: https://zensical.org/docs/authoring/code-blocks/
|
||||
- Zensical customization overview: https://zensical.org/docs/customization/
|
||||
|
||||
Compatibility note:
|
||||
- Zensical is generally expected to remain compatible with MkDocs-style configuration patterns, but prefer Zensical-native documentation and examples when they cover the same behavior.
|
||||
|
||||
## Authoring Guidance for Docstrings
|
||||
|
||||
|
||||
Reference in New Issue
Block a user