Python Docstrings

Open-source Python projects categorized as Docstrings Edit details

Top 5 Python Docstring Projects

  • pdoc

    API Documentation for Python Projects

    Project mention: What is it that makes Rust documentation so special, and how could we make that lightning strike twice in other languages? | | 2022-06-07

    Anyway, this is all my opinion. And a lot of it is based on reflecting on my own experience. I have no idea how well it generalizes. I have given this topic a lot of thought though, and have even written documentation generators for other ecosystems because I thought the other choices were bad enough to warrant spending a few weeks on such a tool.

  • pydocstyle

    docstring style checker

    Project mention: Best general packages to use for Python projects | | 2022-06-13

    Not so much for the project but for project support I always use black for formatting. mypy to check my code. pydocstyle to check the comments.

  • Scout APM

    Less time debugging, more time building. Scout APM allows you to find and fix performance issues with no hassle. Now with error monitoring and external services monitoring, Scout is a developer's best friend when it comes to application development.

  • mkdocstrings

    :blue_book: Automatic documentation from sources, for MkDocs.

    Project mention: Stripe Open Sources Markdoc | | 2022-05-11

    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.


  • pyment

    Format and convert Python docstrings and generates patches

    Project mention: [Python] No docstring formatters? | | 2022-03-31

    I can't find any decent automatic docstring formatter. The only two I stumble upon so far are docformatter and pyment, but none of them wraps long lines. I heard PyCharm has a formatter, but I would rather stick with VSCode.

  • xdoctest

    A rewrite of Python's builtin doctest module (with pytest plugin integration) with AST instead of REGEX.

    Project mention: If you could start your Python journey over with what you know know what practices would you force your past self to implement? | | 2022-04-18

    xdoctest and writing doctests whenever possible

NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020). The latest post mention was on 2022-06-13.

Python Docstrings related posts


What are some of the best open-source Docstring projects in Python? This list will help you:

Project Stars
1 pdoc 1,267
2 pydocstyle 914
3 mkdocstrings 761
4 pyment 736
5 xdoctest 158
Find remote jobs at our new job board There are 2 new remote jobs listed recently.
Are you hiring? Post a new remote job listing for free.
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives