mkdocstrings VS cookietemple

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.

For structure, project setup and getting an idea of how to "style" a project by following best practices, you could take a look at https://github.com/cookiejar/cookietemple. (Disclaimer: I'm one of its authors).

It really depends on how you plan to use your projects: Is it for personal use only? Do you want to use it as a cli application or a standalone package or just some loose script collection? If you want to get an idea of how to structure bigger projects, I recommend you to take a look at https://github.com/cookiejar/cookietemple. (Disclaimer: I'm one of its developers). The cli-python template there should give you a good idea of how a project could actually look like.

In 2020, we did the first release of cookietemple (PyPi: https://pypi.org/project/cookietemple/, GitHub: https://github.com/cookiejar/cookietemple).

The c++ template of https://github.com/cookiejar/cookietemple might be useful to you.

If you're willing to write a cookiecutter version it would be awesome to have it in https://github.com/cookiejar/cookietemple

You could create a project with https://github.com/cookiejar/cookietemple and attempt to understand the structure.

Hey, the post was a nice read ;). As you mentioned cookiecutter, you might also want to take a look at cookietemple (Disclaimer: I'm one of the authors of this project). It is basically designed exactly for this purpose: Setup a modern (python) project with everything needed to start developing in seconds with as much automating of this process as possible.

Cookiecutter is an amazing tool for templating! This could have aided you a lot. I suggest that you check out https://github.com/cookiejar/cookietemple for a Python templates which goes a lot of steps beyond yours for some inspiration. You can always contribute ;)

And if you are looking for an excellent template (collection) you guys should look at https://github.com/cookiejar/cookietemple