mkdocstrings
:blue_book: Automatic documentation from sources, for MkDocs. (by pawamoy)
pydocstyle
docstring style checker (by PyCQA)
Our great sponsors
| mkdocstrings | pydocstyle | |
|---|---|---|
| 9 | 4 | |
| 1,567 | 1,106 | |
| 3.4% | - | |
| 8.3 | 6.1 | |
| 24 days ago | 6 months ago | |
| Python | Python | |
| ISC License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
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.
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.
mkdocstrings
Posts with mentions or reviews of mkdocstrings.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-01-10.
-
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.
pydocstyle
Posts with mentions or reviews of pydocstyle.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-06-13.
-
Best general packages to use for Python projects
Not so much for the project but for project support I always use black for formatting. mypy to check my code. pydocstyle to check the comments.
-
What do you think about this method docstring style?
Check out https://github.com/pycqa/pydocstyle. There's a flake8 extension for it too https://pypi.org/project/flake8-docstrings/
-
Code Quality Tools in Python
pydocstyle
-
What's your 5(ish) year career plan?
something like pydocstyle and make sure all your functions and classes are correctly documented.
What are some alternatives?
When comparing mkdocstrings and pydocstyle you can also consider the following projects:
mkdocs-material - Documentation that simply works
black - The uncompromising Python code formatter
sphinx - The Sphinx documentation generator
autopep8 - A tool that automatically formats Python code to conform to the PEP 8 style guide.
furo - A clean customizable documentation theme for Sphinx
pyment - Format and convert Python docstrings and generates patches
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
pycodestyle - Simple Python style checker in one Python file
pydantic - Data validation using Python type hints
pylama - Code audit tool for python.
mkdocs-markdownextradata-plugin - A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
mkdocstrings vs mkdocs-material
pydocstyle vs black
mkdocstrings vs sphinx
pydocstyle vs autopep8
mkdocstrings vs furo
pydocstyle vs pyment
mkdocstrings vs cookietemple
pydocstyle vs pycodestyle
mkdocstrings vs pydantic
pydocstyle vs pylama
mkdocstrings vs mkdocs-markdownextradata-plugin
pydocstyle vs pre-commit