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.

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

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.

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

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.

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.

A graphical, hierarchical note-taking application, using reStructuredText, python and PyQt.

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.

PyLit (Python-Literate) provides a plain but efficient tool for literate programming: a translator between a *text source* (reStructuredText_ with embedded code blocks) and a *code source* (source code with comment blocks).

Python module and program to extract documentation strings from python functions, classes, and methods and transform them into LaTeX, PDF, HTML, or HTB (wxWidgets help viewer) documents. All file distributions contain compiled help files in PDF and HTB.

Translate comments of Python programs into your language.

A simple and fast way to generate API documentation for Python source code. (text, XML, LaTeX, DocBook, etc) RealDoc does not require modules to be imported, so no hassle with non-running source trees.

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.

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 suite of programs written specifically to address the management of school reports in Waldorf (Rudolf Steiner) schools. It includes a WYSIWIG editor, database storage, and various administration utilities.

The ULM.gen project is a framework that help building and customizing source-code generators from a UML model expressed as XML documents, using generation templates. It also provides tools for synchronization with UML modelers such as IBM Rational Rose.

DIA plugin for automatic UML Class Diagrams generation out of Java source files.

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.

The pycurry project is targeted for handling concurrency issues within the Python programming language. It also contains a (almost) fully functional 'Design by Contract' implementation.

The ‘setupdocx‘ provides a control layer for continuous documentation by the simplified creation, packaging, and installation of documentation. The provided commands are distributed as entry points and optional base classes for further customization into 'setup.py' - setuptools / distutils. Manages arbitrary document templates for the supported builder, supports multiple builds with arbitrary document layouts, designs, and patched contents. The current release supports the following commands: - build_docx - Enhanced documentation. - install_docx - Installs local documentation. - dist_docx - Documentation packaging. - build_apidoc - Standalone Generator for API Documentation - build_apiref - Standalone Generator for API Reference

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.

Collection of tools for modifying the game Warcraft III: The Frozen Throne including frameworks such as "wc3lib" and "Advanced Script Library".