4 ms·
pdoc is my go-to documentation tool for small Python projects. However, when they start to grow, MkDocs and the Material for MkDocs theme make the most sense —
by darkamaul 1y ago
pdoc is my go-to documentation tool for small Python projects.
However, when they start to grow, MkDocs and the Material for MkDocs theme make the most sense — they’re easy to install and deploy, and they offer a ton of features for writing engaging documentation.
[0] https://www.mkdocs.org/ https://www.mkdocs.org/
[1] https://squidfunk.github.io/mkdocs-material/ https://squidfunk.github.io/mkdocs-material/
- klabetron 1y agoLove MkDocs* even for non-Python. But, wasn’t aware it could auto-generate from code comments like pdoc? I’d assume one would use pdoc for the API section of a hot mkdocs layout. *not just because my initials are MK
- darkamaul 1y agoYou can't directly but there is a plugin for this: https://mkdocstrings.github.io/ https://mkdocstrings.github.io/ Example here: https://quarkslab.github.io/quokka/reference/python/executable/ https://quarkslab.github.io/quokka/reference/python/executab...