mkdocstrings VS orjson

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.

orjson is the fastest JSON library available for python. It natively manages dataclass objects, datetime, numpy and UUID objects.

As we began venturing down that road, a few things emerged that would constitute significant changes to some of the core parts of Litestar, but there were two things in particular that started a chain reaction of changes by opening up further possibilities: The new DTOs and our switch from orjson to msgspec.

In version 1.45.0, we introduced msgspec as our serialization backend, replacing orjson. This had some immediate performance benefits, but that's not the main reason we made the switch.

Doesn't orjson do that already?

orjson

For most cases, you would want to go with python’s standard json library which removes dependencies on other libraries. On other hand you could try out ujsonwhich is simple replacement for python’s json library. If you want more speed and also want dataclass, datetime, numpy, and UUID instances and you are ready to deal with more complex code, then you can try your hands on orjson

Try https://github.com/ijl/orjson. Not exactly sure if that can help.