instaunit
mkdocstrings
instaunit | mkdocstrings | |
---|---|---|
2 | 9 | |
22 | 1,572 | |
- | 2.5% | |
3.7 | 8.4 | |
2 months ago | 7 days ago | |
Go | Python | |
- | 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.
instaunit
-
Stripe Open Sources Markdoc
Shameless plug: for REST APIs, I've written a tool called Instaunit which combines HTTP API integration tests with documentation generation, since these two things must always be maintained in lockstep.
It's got a ways to go before it generates output that looks as good as Stripe's documentation, but it makes it dead simple to create API documentation that's guaranteed to be in sync with your service, because it was generated by your tests when they ran.
https://github.com/instaunit/instaunit
-
Is there a recommended Test framework for Rest API?
Check out https://github.com/instaunit/instaunit. It lets you define the calls to be made and expected responses and will compare them semantically so you can match on expected fields without worrying about things like dates and IDs that you can't predict easily. It can also be used to generate documentation for your APIs which is awesome because your docs are then built from your tests so you know they are current and accurate.
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?
markdoc - A literate programming package for Stata which develops dynamic documents, slides, and help files in various formats
mkdocs-material - Documentation that simply works
wstest - go websocket client for unit testing of a websocket handler
sphinx - The Sphinx documentation generator
awesome-go-education - A curated list of awesome articles and resources for learning and practicing Go and its related technologies.
pydocstyle - docstring style checker
docs - Source code for the Streamlit Python library documentation
furo - A clean customizable documentation theme for Sphinx
cryptogalaxy - Get any cryptocurrencies ticker and trade data in real time from multiple exchanges and then save it in multiple storage systems.
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
burp - Somehow idiomatic Go service
pydantic - Data validation using Python type hints