Python Documentation

Open-source Python projects categorized as Documentation Edit details

Top 23 Python Documentation Projects

  • wtfpython

    What the f*ck Python? 😱

    Project mention: abmagick – abuse ImageMagick to create arbitrary files | news.ycombinator.com | 2022-06-02
  • cheat.sh

    the only cheat sheet you need

    Project mention: Linux commands, and the problem with --help and man pages. | reddit.com/r/linux4noobs | 2022-08-10

    wtfis() { curl "https://cheat.sh/$1" }

  • 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.

  • professional-programming

    A collection of full-stack resources for programmers.

    Project mention: These GitHub repositories contain so much knowledge you can use to become a better developer. | reddit.com/r/programming | 2022-07-18
  • MkDocs

    Project documentation with Markdown.

    Project mention: Show HN: Markdown as Web Page/Site | news.ycombinator.com | 2022-08-11
  • sphinx

    Main repository for the Sphinx documentation builder

    Project mention: 30 knowledge base tools for developers in 2022 | dev.to | 2022-08-04

    Sphinx (OpenSource) - Sphinx makes it easy to create intelligent and beautiful documentation.

  • pdoc

    API Documentation for Python Projects

    Project mention: The Slow March of Progress in Programming Language Tooling | news.ycombinator.com | 2022-07-18

    RE browser vs reading the code: sounds like you have a nicer setup than my neovim setup. Although I think my first point still holds unless CLion handles that case too.

    With respect to the rest of your comment, indeed, those are issues. Although I think I take issue with you pinning this on rustdoc. I actually think it's a dance between documentation presentation (so, rustdoc), API design and familiarity with the language.

    I've long said that rustdoc makes unknown unknowns difficult to discover, and this is particularly painful for folks new to Rust. Because you don't really know what to look for yet. And writing docs is a difficult exercise in perspective taking, where you need to balance what you think others know. If you assume they know too little, it's not hard to end up writing too much and adding a fair bit of noise. With that said, I agree that "too little docs" is a far more common problem than "too many docs."

    But yeah, your experience is a perfect example of what I mean when I say "generics complicate APIs." They introduce indirection everywhere, and I'm not sure how much rustdoc can really help with that. You might be right that maybe there are some visualizations that can be added, but like you, I've always seen those as gimmicks in other tools that are rarely useful. IMO, a heavily generic API really requires the crate author to write more prose about how their APIs are intended to be used with lots of concrete examples.

    The interesting bit here is that I've personally found the documentation experience in Rust to be far far better than any other ecosystem. All the way from writing docs up to consuming them. I've sampled many different ecosystems (C, C++, Haskell, Python, Go to name some) and other than maybe Go, I thought the doc experience was really just not great in any of them. Python specifically seems to be a case where I tend to see a lot of variance in opinion. I hated Sphinx so much, for example, that I built an alternative.[1] I also just generally dislike the output that Sphinx produces. I find that it lacks structure, and I've always had a hard time navigating my way through Python library docs.

    [1]: https://github.com/mitmproxy/pdoc

  • apispec

    A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..

  • SonarQube

    Static code analysis for 29 languages.. Your projects are multi-language. So is SonarQube analysis. Find Bugs, Vulnerabilities, Security Hotspots, and Code Smells so you can release quality code every time. Get started analyzing your projects today for free.

  • portray

    Your Project with Great Documentation.

    Project mention: Python toolkits | reddit.com/r/Python | 2022-07-15

    Sphinx along with MyST-parser to write documentation in markdown. I recently discovered portray which seems like a nice alternative as it supports markdown by default for both generic documentation and docstring in modules, class, methods and functions.

  • Pycco

    Literate-style documentation generator.

    Project mention: Lisp.py | news.ycombinator.com | 2022-07-20

    Thanks for the link! I think in that case it was made with https://pycco-docs.github.io/pycco/

  • pyment

    Format and convert Python docstrings and generates patches

    Project mention: [Python] No docstring formatters? | reddit.com/r/vscode | 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.

  • vsphere-automation-sdk-python

    Python samples, language bindings, and API reference documentation for vSphere, VMC, and NSX-T using the VMware REST API

    Project mention: AttributeError: module 'pyVmomi.VmomiSupport' has no attribute 'VmomiJSONEncoder' | reddit.com/r/ansible | 2021-11-05

    I've used this command line to install it on my Debian 12 virtual machine : bash pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git

  • TheHiveDocs

    Documentation of TheHive

  • doorstop

    Requirements management using version control.

    Project mention: Ask HN: How do you keep track of software requirements and test them? | news.ycombinator.com | 2022-04-19

    Zooming into "requirements management" (and out of "developing test cases") there's a couple of Open Source projects that address specifically this important branch of software development. I like both approaches and I think they might be used in different situations. By the way, the creators of these two projects are having useful conversations on aspects of their solutions so you might want to try both and see what's leading from your point of view.

    * https://github.com/doorstop-dev/doorstop

  • dexy

  • amazing-github-template

    🚀 Useful README.md, LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, GitHub Issues, Pull Requests and Actions templates to jumpstart your projects.

    Project mention: 8 Must-Have GitHub Repos for Front-end Developers | dev.to | 2022-04-10

    You can easily create these community health files using the amazing github template generator for your .github or generate for individual repositories.

  • maze

    Maze Applied Reinforcement Learning Framework

    Project mention: [P] Maze: A Framework for Applied Reinforcement Learning | reddit.com/r/MachineLearning | 2021-08-17

    Check out Maze on GitHub - we'd love feedback from anybody with an interest and/or experience in reinforcement learning!

  • mkdocs-monorepo-plugin

    ✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.

  • aiohttp-apispec

    Build and document REST APIs with aiohttp and apispec

    Project mention: Flask vs FastAPI? | reddit.com/r/Python | 2022-05-06

    Here https://github.com/maximdanilchenko/aiohttp-apispec

  • gdscript-docs-maker

    Create documentation and class references from your Godot GDScript code

    Project mention: GDScriptify, the magical documentation tool for GDScript, will be available as a Godot plugin | reddit.com/r/godot | 2022-01-18
  • docs

    Documentation site (by syncthing)

    Project mention: Backup app recommendation | reddit.com/r/androidapps | 2022-06-26

    I am not aware of it. You can look at their documentation or someone at r/Syncthing will be able to tell you for sure.

  • pfFocus

    Generate meaningful output from your pfSense configuration backup, like Markdown documentation.

    Project mention: Multiple Vulnerabilities in PfSense | news.ycombinator.com | 2022-03-18

    I just found these tools for migration. They basically pretty print the configuration XMLs such that one can transfer them manually through the GUI line-by-line and finally verify with the second tool.

    https://github.com/TKCERT/pfFocus

    https://github.com/AndyX90/OPNReport

  • documentation

    Armbian Linux documentation (by armbian)

    Project mention: Any ideas? | reddit.com/r/ManjaroLinux | 2022-04-25

    You can start with this github issue.

  • f4pga

    FOSS Flow For FPGA

    Project mention: Symbiflow: The GCC of the FPGA World | news.ycombinator.com | 2021-09-28
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-08-11.

Python Documentation related posts

Index

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

Project Stars
1 wtfpython 31,444
2 cheat.sh 29,933
3 professional-programming 19,664
4 MkDocs 14,674
5 sphinx 4,825
6 pdoc 1,289
7 apispec 973
8 portray 795
9 Pycco 792
10 pyment 748
11 vsphere-automation-sdk-python 592
12 TheHiveDocs 380
13 doorstop 354
14 dexy 303
15 amazing-github-template 219
16 maze 212
17 mkdocs-monorepo-plugin 196
18 aiohttp-apispec 192
19 gdscript-docs-maker 189
20 docs 180
21 pfFocus 149
22 documentation 118
23 f4pga 107
Find remote jobs at our new job board 99remotejobs.com. There are 3 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
www.saashub.com