formatting
This commit is contained in:
@@ -6,10 +6,10 @@ Use this reference when your docs include API surfaces, function/class documenta
|
||||
|
||||
mkdocstrings helps generate and maintain API reference pages directly from code and docstrings, reducing drift between implementation and docs.
|
||||
|
||||
Primary docs:
|
||||
- mkdocstrings home: https://mkdocstrings.github.io/
|
||||
- mkdocstrings Python handler: https://mkdocstrings.github.io/python/
|
||||
- Griffe (Python parsing engine): https://mkdocstrings.github.io/griffe/
|
||||
!!! info "Primary docs"
|
||||
- [mkdocstrings home](https://mkdocstrings.github.io/)
|
||||
- [mkdocstrings Python handler](https://mkdocstrings.github.io/python/)
|
||||
- [Griffe Python parsing engine](https://mkdocstrings.github.io/griffe/)
|
||||
|
||||
## When to Use It
|
||||
|
||||
@@ -32,13 +32,13 @@ Primary docs:
|
||||
3. Create one API index page per package/domain.
|
||||
4. Expand coverage gradually from high-value modules first.
|
||||
|
||||
General reference examples:
|
||||
- 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/
|
||||
!!! info "General reference examples"
|
||||
- [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.
|
||||
!!! note "Compatibility"
|
||||
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