mkdocstrings VS PRAW

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.

I'm... not sure I understand the question? PRAW still works just fine for "personal use" of the reddit API.

Thank you for pointing out. So there is no need then for the access token? Only with the refresh token is enough? To be honest I took a look at it but I did not expect that to be under authentication as strictly speaking, the user already made the authentication. Also I took a look at the code at https://github.com/praw-dev/praw/blob/master/praw/reddit.py and I did not get a hint whether was possible to pass it or not. I am just saying this to let you know I tried to search for the answer before asking. Again thank you for the help.

To get the relevant IDs, you can use something like PRAW to query the subreddit for the top 1000 posts for example.

Huge thanks to the contributors to PRAW, which is the Python package that does all the heavy lifting relating to Reddit's API that I need for this script.

However, in practice duplicate items were yielded with these smaller numbers. So I increased the limit briefly to 250 in October 2016, and then increased it finally to 301 in December 2016 in order to resolve https://github.com/praw-dev/praw/issues/673. That issue provides an explanation for how 301 came to be.

Why? You gotta be ready for any status code. Even 777.