pydoc-markdown
mm-docs-template
| pydoc-markdown | mm-docs-template | |
|---|---|---|
| 1 | 1 | |
| 441 | 7 | |
| - | - | |
| 5.6 | 7.3 | |
| 11 days ago | 7 months ago | |
| Python | PowerShell | |
| GNU General Public License v3.0 or later | - |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
pydoc-markdown
-
sphinx VS pydoc-markdown - a user suggested alternative
2 projects | 28 Mar 2022
Generate Python API documentation in Markdown format without executing your code.
mm-docs-template
-
Why Your Company's Documentation Sucks
This view is too much simplified. If docs where tree vs graph we would probably have at least some orgs doing it right, while there are literarily almost zero.
Some of the important aspects of good documentation is:
1. Narrative style. You can't do ad hoc whatever wherever and call it a day. Most people don't have it and many are quite illiterate IMO. You need to practice this and most engineers don't like that. Hell, even most seniors don't like writing tickets IME which take almost the same time as putting garbage on Slack. I created templates on both GH and GL and almost nobody uses them even tho you don't need to think about anything but follow few rules.
2. Its quite hard to know what level of detail to put in documentation. You need a lot of experience for this - put to much, and it gets quickly outdated, put too little, and it doesn't convey much. Good documentation exists on multiple levels - as bunch of markup files "on the spot", as formal hi and low level documentation and also those are usually affecting different target groups so you actually need to design docs.
3. Documentation is a service. It has source code, build procedure, automatic link checking, export to bunch of format, crosslinks, variables, macros, configuration for different environments, abbreviations, definitions. Its quite hard to get it right. After years of struggle on different projects I finally created my own stuff [1] that I use on all projects, for docs spanning 50-500 pages. I maintain that for years now, constantly (so yeah, its a job).
[1]: https://github.com/majkinetor/mm-docs-template
What are some alternatives?
pdoc - API Documentation for Python Projects
log4brains - ✍️ Log and publish your architecture decisions (ADR)
sphinx - The Sphinx documentation generator
Doxide - Modern documentation for modern C++. Configure with YAML, output Markdown, post-process with Material for MkDocs.
lazydocs - 📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
docs - The documentation for Firefly III
MkDocs - Project documentation with Markdown.
mm-docs - Documentation system in a docker container using mkdocs, plantuml and many more
markdown-toc-extract - Extract a table of contents from a markdown file (CLI tool)
slap - Slap is a CLI to assist in the process for developing and releasing Python packages.
Optic - OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.