Python documentation-tool

Open-source Python projects categorized as documentation-tool
Edit details
Topics: #documentation-generator #Documentation #Python #Docs #api-documentation
Write Clean Python Code. Always.
Sonar helps you commit clean code every time. With over 225 unique rules to find Python bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.
www.sonarsource.com
Sponsored

Top 14 Python documentation-tool Projects

  • sphinx

    The Sphinx documentation generator

    Project mention: Generate PDF from file (docstrings) | /r/learnpython | 2023-05-16

    So, I've documented my code and now I need a .PDF with this documentation. Is there any easy way to do it? Once I used Sphinx but it generated a not so easy .TeX.

  • pdoc

    API Documentation for Python Projects

    Project mention: what's a good documentation platform that you guys would recommend? | /r/Python | 2022-08-16

    I’ve used sphinx extensively and though it is one of the standards and does a ton, I do not like or recommend it. Personally, I realllly like pdoc for its simplicity. Do not confused pdoc with pdoc3

  • InfluxDB

    Access the most powerful time series database as a service. Ingest, store, & analyze all types of time series data in a fully-managed, purpose-built database. Keep data forever with low-cost storage and superior data compression.

  • eralchemy

    Entity Relation Diagrams generation tool

    Project mention: Tools that help to explore and navigate database tables | /r/dataengineering | 2022-11-21

    sometging like this, maybe https://github.com/Alexis-benoist/eralchemy

  • pdoc

    :snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects (by pdoc3)

    Project mention: Asian faiths try to save swastika symbol corrupted by Hitler | news.ycombinator.com | 2022-11-27

    Also seen in GitHub in the wild at times. Always brings interesting discussions...

    https://github.com/pdoc3/pdoc/issues/87

    I've learnt a lot about cultures through those PRs

  • pydoc-markdown

    Create Python API documentation in Markdown format.

  • ford

    Automatically generates FORtran Documentation from comments within the code.

  • mike

    Manage multiple versions of your MkDocs-powered documentation via Git

    Project mention: where do you host your embedded docs? | /r/embedded | 2022-11-26

    I use MkDocs for generating the documentation website (using the Material theme) and host in on GitHub pages. For managing and hosting multiple versions, I use the Mike extension for MkDocs.

  • Sonar

    Write Clean Python Code. Always.. Sonar helps you commit clean code every time. With over 225 unique rules to find Python bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.

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

    Project mention: Can Code GPT document a python code? | /r/CodeGPT_VSCode | 2023-05-05

    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.

  • nbdev_template

    Template for nbdev projects

  • gdscript-docs-maker

    Create documentation and class references from your Godot GDScript code

  • strictdoc

    Software for technical documentation and requirements management.

  • hitchstory

    Type-safe YAML integration tests. Tests that write your docs. Tests that rewrite themselves.

    Project mention: Ask HN: BDD and Gherkin tests, do they provide value in the real world? | news.ycombinator.com | 2023-06-08

    I like the idea a lot but I felt that the Gherkin language itself was inappropriate for the task for four main reasons:

    * Verbosity

    * Not type safe

    * It doesnt have story abstractions (i.e. you can't flexibly create variations on a story).

    * The use of regexes for parsing

    I created a YAML based alternative with python that I think has all of the benefits and fixes those 4 problems: https://hitchdev.com/hitchstory

  • sphinxcontrib-hdl-diagrams

    Sphinx Extension which generates various types of diagrams from Verilog code.

  • qe-docset

    Dash docset generator for Quantum ESPRESSO.

    Project mention: I’m a Productive Programmer with a Memory of a Fruit Fly | news.ycombinator.com | 2022-09-19

  • SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

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 2023-06-08.

Python documentation-tool related posts

Index

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

Project Stars
1 sphinx 5,464
2 pdoc 1,550
3 eralchemy 1,017
4 pdoc 971
5 pydoc-markdown 405
6 ford 355
7 mike 334
8 AutoDoc-ChatGPT 295
9 nbdev_template 269
10 gdscript-docs-maker 203
11 strictdoc 92
12 hitchstory 44
13 sphinxcontrib-hdl-diagrams 39
14 qe-docset 5

Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com