BlackSheep VS mkdocstrings

Try BlackSheep | Kore | socketify | baize

As you can see, in this benchmark Starlite handily beats even blakchseep, a notoriously fast ASGI framework written in Cython

If you have something that really needs to go fast, I recommend blacksheep. FastAPI is slow as molasses compared to blacksheep, and as of to date, the fastest python async web framework with the established feature set. It’s written in cython, so that might something to consider if you want to work with the source code somehow.

Personally I haven’t used it outside of trying a few very basic things. I’d recommend blacksheep if you want small, performant and low overhead, or sanic which, in my opinion, is the best choice if you do not need all the Django fluff.

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.

mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.

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/

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.

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.

I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?

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.