Top 19 Python documentation-generator Projects

• jupyter-book

  15 3,692 8.5 Python

  Create beautiful, publication-quality books and documents from computational content.

  

Project mention: I don't always use LaTeX, but when I do, I compile to HTML (2013) | news.ycombinator.com | 2024-01-25

Sphinx supports ReStructuredText and Markdown.

MyST-Markdown supports MathJaX and Sphinx roles and directives. https://myst-parser.readthedocs.io/en/latest/

jupyter-book supports ReStructuredText, Jupyter Notebooks, and MyST-Markdown documents:

You can build Sphinx and Jupyter-Book projects with the ReadTheDocs container, which already has LaTeX installed: https://github.com/executablebooks/jupyter-book/issues/991

myst-templates/plain_latex_book:

• drf-yasg

  8 3,327 1.5 Python

  Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.

• InfluxDB

  www.influxdata.com featured

  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.

  

• drf-spectacular

  9 2,112 8.6 Python

  Sane and flexible OpenAPI 3 schema generation for Django REST framework.

Project mention: Why I chose django-ninja instead of django-rest-framework to build my project | /r/django | 2023-06-17

Hi, while that is the case, same can be done with drf using drf-spectacular

• pdoc

  10 1,813 8.2 Python

  API Documentation for Python Projects

  

Project mention: How to Write Impeccably Clean Code That Will Save Your Sanity | dev.to | 2023-07-27

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

• readme-ai

  6 1,233 9.7 Python

  👾 Automated README file generator, powered by large language model APIs.

Project mention: README-AI: Auto-generate README.md files! | /r/Python | 2023-05-18

Hey fellow Redditors, Just wanted to share a cool way I've been using ChatGPT recently. I've been messing around with README-AI, a fantastic tool that auto-generates really slick README files for GitHub repos, and I had an idea for a new feature (GitLab support, for anyone interested). But rather than write the feature request issue myself, I let ChatGPT handle it! That's right, I got an AI to write a GitHub issue for a tool that uses AI. Sounds like an inception, right? Check out the issue here: https://github.com/eli64s/README-AI/issues/13 I think it's pretty impressive how coherently and effectively ChatGPT can communicate an idea. Just another interesting application for AI. Anyone else using ChatGPT in novel ways? Would love to hear your stories! Oh, and just for the record, this Reddit comment itself was also generated by ChatGPT. It seems like the AI rabbit hole goes even deeper. 😉 Cheers!

• pdoc

  3 1,089 6.0 Python

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

  

• pydoc-markdown

  1 441 5.6 Python

  Create Python API documentation in Markdown format.

• SaaSHub

  www.saashub.com featured

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

  

• amazing-github-template

  4 414 0.0 Python

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

• ford

  1 389 9.3 Python

  Automatically generates FORtran Documentation from comments within the code.

  

• AutoDoc-ChatGPT

  1 379 4.2 Python

  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

  1 285 0.0 Python

  Template for nbdev projects

  

• pfFocus

  8 280 2.0 Python

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

  

Project mention: Migrating to OPNsense after years of PFSense | /r/homelab | 2023-05-08

• strictdoc

  1 138 9.8 Python

  Software for technical documentation and requirements management.

  

• website-to-gif

  3 104 7.7 Python

  GitHub Action to turn your website into a GIF :camera:

Project mention: website-to-gif: A GH Action to turn a webpage into a GIF | /r/opensource | 2023-10-23

• sphinx-vhdl

  1 19 0.0 Python
  

• aidoc

  1 10 10.0 Python

  A simple CLI tool to generate documentation for your Python projects automatically.

• Obidog

  1 4 4.3 Python

  Öbengine BInding and DOcumentation Generator

  

• cdox

  1 1 0.0 Python

  documentation generator for generating C API docs in markdown format

• automd

  1 0 0.0 Python

  Flask API Documentation Generation

• SaaSHub

  www.saashub.com featured

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

  

Python documentation-generator related posts

• Is there such a thing as local Llamas integrated into VSCode?

  12 projects | /r/LocalLLaMA | 20 May 2023

• Python Stock Exchange Simulator

  1 project | /r/PythonProjects2 | 20 Sep 2022

• Are there any frameworks/methodologies/libraries that can help to create a PDF printable professionally looking written report?

  3 projects | /r/pythontips | 16 Aug 2022

• Literate programming is much more than just commenting code

  15 projects | news.ycombinator.com | 21 Mar 2022

• Ask HN: Tools to generate coverage of user documentation for code

  2 projects | news.ycombinator.com | 21 Mar 2022

• Why does [::-1] reverse a list?

  2 projects | /r/learnpython | 12 Mar 2022

• Ask HN: Best Tools for Technical Writing?

  2 projects | news.ycombinator.com | 12 Jan 2022
• A note from our sponsor - SaaSHub
  www.saashub.com | 1 May 2024

  SaaSHub helps you find the best software and product alternatives Learn more →

Index

Sponsored

SaaSHub - Software Alternatives and Reviews

SaaSHub helps you find the best software and product alternatives

www.saashub.com

Do not miss the trending Python projects with our weekly report!