pdoc
mkdocstrings
pdoc | mkdocstrings | |
---|---|---|
3 | 9 | |
1,091 | 1,579 | |
2.0% | 2.5% | |
6.0 | 8.4 | |
about 2 months ago | 1 day ago | |
Python | Python | |
GNU Affero General Public License v3.0 | 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.
pdoc
-
Asian faiths try to save swastika symbol corrupted by Hitler
Also seen in GitHub in the wild at times. Always brings interesting discussions...
https://github.com/pdoc3/pdoc/issues/87
I've learnt a lot about cultures through those PRs
-
Python Stock Exchange Simulator
3) I used a library called pdoc (https://pdoc3.github.io/pdoc/). It is similar to sphinx but much easier to implement.
-
what's a good documentation platform that you guys would recommend?
Seems like that is actually a Hindu symbol? Anyways, relevant controversy here: https://github.com/pdoc3/pdoc/issues/346
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?
mkdocs-render-swagger-plugin - A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.
mkdocs-material - Documentation that simply works
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
linode-api-docs - Source for the Linode API v4 Docs
pydocstyle - docstring style checker
pdoc - API Documentation for Python Projects
furo - A clean customizable documentation theme for Sphinx
docs - Documentation for Tasmota (https://github.com/arendst/Tasmota)
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
AutoDoc-ChatGPT - AutoDoc-ChatGPT is a Python script that leverages the power of ChatGPT model to automatically generate documentation for any programming language. With AutoDoc-ChatGPT, you can easily generate comprehensive documentation for your codebase.
pydantic - Data validation using Python type hints