Open Source Python Documentation Software

Leo is an outlining-oriented project manager and browser. With Leo you can organize programs, web sites, URL's, pictures or any other kind of data. Leo is fully scriptable in Python. Leo is 100% pure Python. It requires the Qt gui toolkit.

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.

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.

Papermerge is an open source document management system (DMS) primarily designed for archiving and retrieving your digital documents. Instead of having piles of paper documents all over your desk, office or drawers - you can quickly scan them and configure your scanner to directly upload to Papermerge DMS. Store, organize and index scanned documents in PDF, JPEG and TIFF formats. Instantly find relevant information using full text, tags and metadata-based search. Papermerge is free and open-source software which means that transparency is the core value of our software development. Source code can be reviewed and improved by anyone from anywhere. Papermerge supports multiple users. Each user can be assigned different permissions to perform only a specific kind of action e.g. view only documents from a specific folder. OCR technology is vital part of Papermerge. It extracts text information from scanned documents, PDF, JPEG, TIFF files.

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

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.

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

Each larger open source project has its own style guide, a series of conventions on how to write code for the project (sometimes more arbitrary). When all the code maintains a consistent style, it is more important when understanding large code bases. easy. The meaning of "style" covers a wide range, from "variables use camelCase" to "never use global variables" to "never use exceptions". The English version of the project maintains the programming style guidelines used in Google. If the project you are modifying originates from Google, you may be directed to the English version of the project page to understand the style used by the project. The Chinese version of the project uses reStructuredText plain text markup syntax, and uses Sphinx to generate document formats such as HTML / CHM / PDF.

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information. There's a stack of good-looking themes available for MkDocs. Choose between the built in themes: mkdocs and readthedocs, select one of the third-party themes listed on the MkDocs Themes wiki page, or build your own. Get your project documentation looking just the way you want it by customizing your theme and/or installing some plugins. Modify Markdown's behavior with Markdown extensions. Many configuration options are available. The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.

"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

SGML-tools Lite was a subset of SGML-tools (www.sgmltools.org), providing a friendly Python interface to SGML software specificially in a DocBook/OpenJade environment. SGML-tools Lite is no longer actively developed.

Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc. It is designed to help the user concentrate on writing content without been distracted by format or markup. It offers a rich WYSIWYM interface where the user writes plain text with a lightweight markup language.

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

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.

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.

proto2cpp is a Python script which converts Google Protocol Buffers files to C++ style output for Doxygen.

Txt2tags converts a text file with minimal markup to HTML, XHTML, SGML, LaTeX, Lout, UNIX Man Page, Wikipedia, Google Code Wiki, DokuWiki, MoinMoin, MagicPoint(mgp), PageMaker. Features: simple, fast, automatic TOC, macros, filters, include, GUI/CLI/

A text viewer utility that displays text in a pango like markup. The utility is written in python, and uses the pygtk toolkit. The parser reads pango tags similar to html. The utility was written, so formatted text can be displayed quickly. NEW! The parser now is updated to use a faster method of internal data structure.

Wenost simplifies the process of building and maintaining larger web sites by hand. Wenost is used in conjunction with PPWizard, a free HTML pre-processor. For examples of websites built with wenost see www.csem.org.uk and the wenost project website.

HyperSQL is like a doxygen plus javadoc for SQL, hypermapping SQL views, packages, procedures, and functions to HTML source code listings and showing all code locations where these are used.

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.

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

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.

Analyzes programs (and projects) written in Cobol and generates information (HTML) for its easy reading, understanding and analysis.

pyWeb is a Literate Programming tool that will work with any markup language and any programming langauge. The idea is to allow you to create great documentation with as constraints or limitations.