github-starred/awesome-python
2
0
Fork 0
mirror of https://github.com/vinta/awesome-python.git synced 2026-11-10 01:34:28 -06:00
Code Issues 461 Packages Projects Releases Wiki Activity

audit: restructure Documentation into use cases

Browse Source 
The flat list mixed three jobs, so the tiers ranked diagrams and pdoc against site generators.

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Vinta Chen
2026-11-08 20:27:52 +08:00
co-authored by Claude
parent 07ff0b0a5a
commit f415b2093a
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -6
View File
@@ -740,12 +740,15 @@ _Task runners and software build tools. If you're looking for Python packaging/b
_Libraries for generating project documentation._
- [sphinx](https://github.com/sphinx-doc/sphinx) - Python documentation generator.
- [awesome-sphinxdoc](https://github.com/ygzgxyz/awesome-sphinxdoc)
- [mkdocs-material](https://github.com/squidfunk/mkdocs-material) - A documentation framework and Material Design theme built on MkDocs.
- [diagrams](https://github.com/mingrammer/diagrams) - Diagram as Code.
- [pdoc](https://github.com/mitmproxy/pdoc) - Auto-generates API documentation for Python projects.
- [zensical](https://github.com/zensical/zensical) - A modern static site generator for technical documentation.
- Site Generators
- [sphinx](https://github.com/sphinx-doc/sphinx) - A Python documentation generator.
- [awesome-sphinxdoc](https://github.com/ygzgxyz/awesome-sphinxdoc)
- [mkdocs-material](https://github.com/squidfunk/mkdocs-material) - A documentation framework and Material Design theme built on MkDocs.
- [zensical](https://github.com/zensical/zensical) - A static site generator for documentation, from the Material for MkDocs team.
- API Reference
- [pdoc](https://github.com/mitmproxy/pdoc) - Auto-generates API documentation for Python projects.
- Diagrams
- [diagrams](https://github.com/mingrammer/diagrams) - Diagrams as code for prototyping cloud system architectures.
**DevOps**