SaaSHub helps you find the best software and product alternatives Learn more →
Top 17 Python documentation-tool Projects
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
AutoDoc-ChatGPT
AutoDoc-ChatGPT is a Python script that leverages the power of ChatGPT model to automatically generate documentation for any programming language. With AutoDoc-ChatGPT, you can easily generate comprehensive documentation for your codebase.
-
hitchstory
Type-safe YAML integration tests. Tests that write your docs. Tests that rewrite themselves.
-
sphinxcontrib-hdl-diagrams
Sphinx Extension which generates various types of diagrams from Verilog code.
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
Sphinx is primarily known as a documentation generator, but it can also be used to create static websites. It excels in generating technical documentation, and its support for multiple output formats, including HTML and PDF, makes it a versatile tool. Sphinx uses reStructuredText for content creation and is highly extensible through plugins.
Project mention: How to Write Impeccably Clean Code That Will Save Your Sanity | dev.to | 2023-07-27You can also use doc-strings to generate automated documentation for your code using a library like pdoc. Consider the following example from Stack-Scraper and the corresponding documentation generated using pdoc library.
I have been using AutoDoc-ChatGPT (https://github.com/awekrx/AutoDoc-ChatGPT) to document python code. For this I need to use either command line or paste the code to be documented in another script, which can get a bit troublesome.
Project mention: website-to-gif: A GH Action to turn a webpage into a GIF | /r/opensource | 2023-10-23
Project mention: Winner of the SF Mistral AI Hackathon: Automated Test Driven Prompting | news.ycombinator.com | 2024-03-27I built something like this too:
https://github.com/hitchdev/hitchstory/blob/master/examples%...
Paracelsus creates diagrams in markdown or dot format for SQLAlchemy defined databases.
Python documentation-tool related posts
- best packages for documenting the flow of logic?
- Generate PDF from file (docstrings)
- dictf - An extended Python dict implementation that supports multiple key selection with a pretty syntax.
- Pipeline documentation
- Minimum Viable Hugo – No CSS, no JavaScript, 1 static HTML page to start you off
- Ruff: An fast Python linter, written in Rust
- where do you host your embedded docs?
-
A note from our sponsor - SaaSHub
www.saashub.com | 19 Apr 2024
Index
What are some of the best open-source documentation-tool projects in Python? This list will help you:
Project | Stars | |
---|---|---|
1 | sphinx | 6,028 |
2 | pdoc | 1,807 |
3 | pdoc | 1,088 |
4 | eralchemy | 1,074 |
5 | mike | 465 |
6 | pydoc-markdown | 438 |
7 | ford | 388 |
8 | AutoDoc-ChatGPT | 379 |
9 | nbdev_template | 279 |
10 | gdscript-docs-maker | 242 |
11 | strictdoc | 137 |
12 | website-to-gif | 104 |
13 | hitchstory | 83 |
14 | paracelsus | 73 |
15 | sphinxcontrib-hdl-diagrams | 49 |
16 | qe-docset | 5 |
17 | Linki | 3 |