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.

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.

"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

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.

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.

Qiskit [kiss-kit] is an open-source SDK for working with quantum computers at the level of pulses, circuits, and application modules. When you are looking to start Qiskit, you have two options. You can start Qiskit locally, which is much more secure and private, or you get started with Jupyter Notebooks hosted in IBM Quantum Lab. Qiskit includes a comprehensive set of quantum gates and a variety of pre-built circuits so users at all levels can use Qiskit for research and application development. The transpiler translates Qiskit code into an optimized circuit using a backend’s native gate set, allowing users to program for any quantum processor or processor architecture with minimal inputs. Users can run and schedule jobs on real quantum processors, and employ Qiskit Runtime to orchestrate quantum programs on cloud-based CPUs, QPUs, and GPUs.

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.

Paperless is a simple Django application running in two parts, a Consumer (the thing that does the indexing) and a Web server (the part that lets you search & download already-indexed documents). Paper is a nightmare. Environmental issues aside, there’s no excuse for it in the 21st century. It takes up space, collects dust, doesn’t support any form of a search feature, indexing is tedious, it’s heavy and prone to damage & loss. I wrote this to make “going paperless” easier. I do not have to worry about finding stuff again. I feed documents right from the post box into the scanner and then shred them. Perhaps you might find it useful too. Paperless-ng is a fork of the original paperless project. It changes many things both on the surface and under the hood. Paperless-ng was created because I feel that these changes are too big to be pushed into the main repository right away.

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.

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.

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.

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.

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

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.

Make AsciiDoc part of your literate programming tool set. With eWEB you can weave and tangle literate programs written as AsciiDoc documents, using embedded WEB code snippets.

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.

Extracts code from source files for inclusion in documentation.

uListen is a TTS(Text To Speech) application. It can TALK you the web pages, chm files, pdf files and word files and plain text files.

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.

POST (Python Obviously Simple Text) provides support for simple, flexible dynamic document generation in multiple output formats. Supports inputs in text or XML, outputs in HTML, PDF, RTF, LaTeX source, nroff source, postscript, and plain text.

Steel Rats is a gui wrapper for the command line source code auditing tool RATS. It examines C, Perl, php and python code for keywords that could cause security holes and provides a report for you to further investigate the possible security holes.

A Python tool for creating websites or project documentation. Pages can be stored as reST (text) or html. With a simple templating and macro system it can autogenerate index pages and navigation links. Facilities for multiple translations as well.

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.

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.