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.

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.

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

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

A clean customizable Sphinx documentation theme. Intentionally minimal, the most important thing is the content, not the scaffolding around it. Responsive, adapting perfectly to the available screen space, to work on all sorts of devices. Customizable, change the color palette, font families, logo and more! Easy to navigate, with carefully-designed sidebar navigation and inter-page links. Good-looking content, through clear typography and well-stylized elements. Good looking search, helps readers find what they want quickly. Biased for smaller docsets, intended for smaller documentation sets, where presenting the entire hierarchy in the sidebar is not overwhelming. Furo allows customizing the icons that are presented in the page footer. These icons can be used to link to relevant resources for your project and documentation.

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

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.

SLOCCount is an easy-to-use tool that counts Source Lines of Code (SLOC). It auto-determines the language(s) (inc. C, C++, Ada, Assembly, shell, COBOL, C#, Fortran, Haskell, Java, LISP/Scheme, Perl, PHP, Python, Ruby, SQL). It also estimates cost & time.

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.

DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of powerful GPT models, developers can easily ask questions about a project and receive accurate answers. Say goodbye to time-consuming manual searches, and let DocsGPT help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance.

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

The tensorflow-zh repository is a Chinese translation of the official TensorFlow documentation, organized to make the core guides, tutorials, and reference material accessible to Chinese speakers. It was initiated shortly after TensorFlow’s open-sourcing, with translation and proofreading contributions from a community of volunteers who aimed to bridge the language barrier for learners in China and other Mandarin communities. The repo mirrors the structure of the original English docs: chapters, sections, code examples, API references, and supplementary content like configuration and build guides. It includes additional files like a PDF version (compiled LaTeX/TeX sources), table of contents mappings, and translation metadata to track contributions. Over time, the repo has evolved to stay in sync with upstream changes, providing versioned snapshots of the translated content.

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.

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.

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.

reStructuredText defines & implement a markup syntax for use in Python docstrings and other documentation domains, that is readable & simple, yet powerful. Project inactive. Development taken over by Docutils, http://docutils.sourceforge.net/.

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/

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.

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.

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

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

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.

Tools for extracting and transforming XML-like mark-up, embedded in source code comments, into proper external entities or well-formed XML files. Can be used for JavaDoc-like "literate programming", or embedding other build-related or CM metadata.