mm-docs
mkdocstrings
mm-docs | mkdocstrings | |
---|---|---|
2 | 9 | |
16 | 1,579 | |
- | 2.5% | |
5.6 | 8.4 | |
7 months ago | 2 days ago | |
PowerShell | Python | |
GNU General Public License v3.0 only | ISC License |
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.
mm-docs
-
Stripe Open Sources Markdoc
I am glad to know there are those that put so much thought into documentation. Documentations is just another service, and deserves all the same methodology: CI/CD, tests, components, reuse etc.
As far as I can see, you can get similar workflow with combination of existing tools. I created this docker image that combines them for very easy consumption and created thousands of pages of technical, functional and user documentation with it:
https://github.com/majkinetor/mm-docs
- Show HN: Documentation system for any kind of project and documentation type
mkdocstrings
-
Starlite development updates January ’23
Mkdocs has the mkdocstrings plugin, offering limited automated API documentation capabilities. It is however nowhere near as capable as Sphinx' autodoc, missing granularity in its configuration, limited intersphinx-like cross-referencing support, and essential features like documentation of inherited members, or the ability to manually describe objects if needed.
-
what's a good documentation platform that you guys would recommend?
mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.
-
Stripe Open Sources Markdoc
Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.
[1]: https://mkdocstrings.github.io/
- Mkdocstrings: Automatic Python documentation from sources, for MkDocs
- Technical documentation that just works
-
mkdocstrings: the "autodoc" plugin for MkDocs
Some time has passed since I first introduced mkdocstrings here on reddit. If you don't know what mkdocstrings is: it's the equivalent of the autodoc Sphinx extension, but for MkDocs, a Markdown static site generator. It works differently though, and supports multiple languages by design (not only Python). Someone actually wrote a very good handler for the Crystal language, and another user on GitHub recently expressed their interest for writing one for Go.
-
Python tutorials building large(r) projects
Write proper docstrings as you go along (every time you write a new class/method/function you can document what it’s doing as you’ll know why and what from the pattern you chose). Using a tool like mkdocstrings makes maintaining documentation for larger projects automatic.
-
[Project] mkgendocs - Generating documentation from Python docstrings for MkDocs
I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?
-
Python packages and plugins as namespace packages
A user of mkdocstrings wrote a Crystal handler for their own use-case. They asked on the Gitter channel if we could allow to load external handlers, so they don't have to fork the project and install the fork, but rather just install their lightweight package containing just the handler.
What are some alternatives?
remark - markdown processor powered by plugins part of the @unifiedjs collective
mkdocs-material - Documentation that simply works
ConvertOneNote2MarkDown - Ready to make the step to Markdown and saying farewell to your OneNote, EverNote or whatever proprietary note taking tool you are using? Nothing beats clear text, right? Read on!
sphinx - The Sphinx documentation generator
mm-docs-template - Template to use with mm-docs
pydocstyle - docstring style checker
docs - Source code for the Streamlit Python library documentation
furo - A clean customizable documentation theme for Sphinx
markdoc - A literate programming package for Stata which develops dynamic documents, slides, and help files in various formats
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
docs - Documentation site for Markdoc
pydantic - Data validation using Python type hints