Timothée Mazzucotelli
@pawamoy.bsky.social
Open-source dev (mkdocstrings and many more) :)
Reposted by Timothée Mazzucotelli
If you use mkdocs for your python docs, and want quick full API autogen (with navigation) try
github.com/tlambert03/m...
Particularly if you currently use the mkdocs-gen-files/literatenav/custom-script approach
github.com/tlambert03/m...
Particularly if you currently use the mkdocs-gen-files/literatenav/custom-script approach
GitHub - tlambert03/mkdocs-api-autonav
Contribute to tlambert03/mkdocs-api-autonav development by creating an account on GitHub.
github.com
February 5, 2025 at 11:11 PM
If you use mkdocs for your python docs, and want quick full API autogen (with navigation) try
github.com/tlambert03/m...
Particularly if you currently use the mkdocs-gen-files/literatenav/custom-script approach
github.com/tlambert03/m...
Particularly if you currently use the mkdocs-gen-files/literatenav/custom-script approach
Reposted by Timothée Mazzucotelli
This document rom the griffe docs is *awesome*. Basically a missing manual on designing the public API for your Python package: extremely well written, with good tips for beginners and advanced devs alike.
mkdocstrings.github.io/griffe/guide...
mkdocstrings.github.io/griffe/guide...
Public APIs - Griffe
Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.
mkdocstrings.github.io
February 5, 2025 at 11:53 PM
This document rom the griffe docs is *awesome*. Basically a missing manual on designing the public API for your Python package: extremely well written, with good tips for beginners and advanced devs alike.
mkdocstrings.github.io/griffe/guide...
mkdocstrings.github.io/griffe/guide...