Open Source Python Documentation Software

Utilities for general- and special-purpose documentation. Includes reStructuredText, the easy to read, easy to use, what-you-see-is-what-you-get plaintext markup language.

"Roberge's Used Robot (RUR) : a Python Learning Environment" is a Python implementation of a "robot environment" as introduced by R. Pattis in 1981. **It is obsolete.** See https://github.com/aroberge/rur-ple

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. Of course, this site is also created from reStructuredText sources using Sphinx! HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text. Semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information. Easy definition of a document tree, with automatic links to siblings, parents and children. General index as well as a language-specific module index. Automatic highlighting using the Pygments highlighter. Automatic testing of code snippets, the inclusion of docstrings from Python modules (API docs), and more.

AsciiDoc is a presentable text document format for writing articles, UNIX man pages and other small to medium sized documents. The asciidoc(1) command translates AsciiDoc files to HTML, DocBook and LinuxDoc formats.

DocsGPT is an open-source AI platform for deploying private RAG pipelines, AI agents, and enterprise search on your own infrastructure. Connect any data source (PDFs, DOCX, CSV, Excel, HTML, audio, GitHub, databases, URLs) and get accurate, hallucination-free answers with source citations. Choose your LLM: OpenAI, Anthropic, Google Gemini, or local models. Works with Qdrant, MongoDB, and Elasticsearch and more. Deploy via Docker or Kubernetes with full data sovereignty. Build embeddable chat and search widgets, automate multi-step workflows with AI agents, and integrate via Slack, Telegram, Discord, or REST API. Enterprise features include RBAC, 99.9% uptime SLA, and dedicated support. MIT licensed.

nginx-admins-handbook is a practical, in-depth guide for configuring, securing, and operating NGINX across real-world deployments. It distills years of research, notes, and field experience into a single handbook that complements the official docs with concrete rules, explanations, and curated external references. The handbook spans fundamentals and advanced topics alike, from HTTP and SSL/TLS basics to reverse proxy patterns, performance tuning, debugging workflows, and hardening strategies. A centerpiece is its prioritized checklist of 79 rules, grouped by criticality, helping readers focus on what most impacts security, reliability, and speed. Instead of copy-paste snippets in isolation, it emphasizes understanding trade-offs, avoiding common pitfalls, and balancing security with usability. Designed for system administrators and web application engineers, it aims to be a living companion that encourages experimentation, measurement, and continuous improvement of NGINX configurations

Python Audio Tools are a collection of audio handling programs. These include programs for CD extraction, track conversion from one audio format to another, track renaming and retagging, track identification, CD burning from tracks, and more.

Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. Epydoc supports two output formats (HTML and PDF), and four markup languages for docstrings (Epytext, Javadoc, ReStructuredText, and plaintext).

The purpose of this project is to create a German translation of the book <a href="http://www.byteofpython.info">"A Byte of Python"</a> originally written in English by Swaroop C H.

DocLite is a simple documentation authoring system, it produces multi-page HTML output (like this document) in a style similar to that found in the Linux HOTWTOs or other DocBook created documents.

Eng: Digital Signature with x.509 certificates and smartcards for PDFand PAdES format documents in Spanish for Windows OS (8 and 10). Esp: Firma Digital de documents electrónicos PDF en formato PAdES con certificados digitales X.509 y tokens criptográficos en español.

2023/04/04: MIGRATED TO https://gitlab.com/wef/gjots2 gjots2 is a fairly simple jotter (outline processor) application for your desktop. See http://bhepple.freeshell.org/gjots

Extracts code from source files for inclusion in documentation.

A general interface which loads programming demos from an XML file inspired by the gtk-demo program.

ARREA (A Reasonable Requirements Engineering Application) is a simple yet powerful requirements management tool that uses arbitrary files to store information and Subversion to allow team collaboration. Its simple conventions make it suitable for much other purposes. In fact, for any document-oriented tasks focused on collaborative work and exhaustive change and traceability management. At its heart, ARREA provides a thin layer on top of SVN that allows it to be used as a powerful time-aware NoSQL database, accessible through an easy REST API.

AFMS is an Artefact Management System to manage some of the artefacts appearing in the development process of a product. Artefacts are for example requirements, use cases or test cases. AFMS contains an artefact editor and a test execution tool.

AsciiLitProg is a programming language neutral literate programing tool based on AsciiDoc.

A collection of graph classification methods, covering embedding, deep learning, graph kernel and factorization papers with reference implementations. Relevant graph classification benchmark datasets are available. Similar collections about community detection, classification/regression tree, fraud detection, Monte Carlo tree search, and gradient boosting papers with implementations.

Full blender integrated documentation and multi-language translation (help) > Python script for Blender, a free open source 3D content creation suite, available for all major operating systems under the GNU General Public License.

CodeInvestigator is a tracing tool for Python programs. All the run time information is recorded. Read your code together with its run time details. Use it to visualize what happened when you program ran.

Provides a toolset and usage convention for Code Tags (eg TODO, FIXME, BUG) in source file comments.

System to assist with the management of a local Buddhist study library. Will download and install chosen documentation (sutras, etc), index them, and provide a web interface. Python, HTML. Needs a webserver, namazu. Can be used for other documents, too.

A Graphic User Interface with texteditor and category browser for interaction with the free encyclopedia Wikipedia

Comparing two different versions of a directory with text files of any kind has never been easier. Detects deleted files, new files, files with changed name but same content and of course a side-by-side / line-by-line comparison of changed files. Number of context-lines is configurable. Here's, how to call it: >python DirDiff.py dir1 dir2 output.html or >python.exe DirDiff.py -l 3 -v olddir newdir dirdiff.html -l is the number of context lines in the side-by-side comparison. -v lists all files, that exist in both directories and have the same content. Both directory names need to end with the "/" (Linux) or "\" (Windows).

The Django-driven web-based book-authoring content-management-system (ddwbbacms) is a program that allows authors to work on their books, articles, or topics without having to have their hard drives nearby. Access to the web is all that is required.