Open Source Python Documentation Software

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

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

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.

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.

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.

GnuConcept is a networking and colaborative mindmap tool for the creation of complex documents. This program lets you draw the document concept map, edit all the concepts content and export it to several formats (like openoffice, dockbook and html)

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.

Professional environments focus on high development standards in Source Code Management. E.g. by usage of server side commit hooks to check for minimum acceptance levels on code and documentation quality including commit message structure and content. TortoiseSVN offers only a free form text field to edit inside the Commit Dialog. Developers might recall situations when struggling with commit message structure and fighting the server side commit hooks instead of focusing on message content! Thus being annoyed instead of feeling an incentive to deliver high quality descriptions here. The SVNStartCommitHelper is a client side start commit hook script (as a first version written in Python / Tkinter) exactly offering a well-structured form to fill in. The edited content is transformed and forwarded to the SVN commit dialog then. You still have full control on the commit message then. While using the helper you focus on message quality now instead struggling with message structure.

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.

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.

Extracts code from source files for inclusion in documentation.

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.

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.

This project has been moved to GitHub: https://github.com/tomschr/dbcookbook/ The DoCookBook project aims to create an open source book about DocBook and the DocBook XSL stylesheets written as a cookbook and released under a Creative Commons license.

DocScript is an approach to document preparation. It presents tools and utilities to edit and publish documents. The philosophy behind the DocScript project is to utilize the programming tools you're working with anyway in your daily work.

This editor aims to help users creating their own ebooks in the newly released Open Publishing standard defined by International Digital Publishing Forum. The editor will permit the creatioin of ebook in OCF-1.0 format (.epub)

A Python programming environment providing memory sizing, profiling and analysis, and a specification language that can formally specify aspects of Python programs and generate tests and documentation from a common source.

Hylt is a file format that provides HYperLinked Text with minimal markup, meant to be both easy to view in any program and easy to keep in a version control system. The Hylt project covers the file specification, viewers, and tools to manage Hylt files.

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.