Open Source Python Documentation Software for Linux

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.

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

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.

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.

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.

Read the Docs is a platform that automates building, versioning, and hosting documentation from source repositories. Supporting Sphinx, MkDocs, Jupyter Book, and more, it integrates with GitHub, GitLab, and Bitbucket to trigger automatic builds upon updates. Both open-source projects and private documentation can be hosted, with previews, search, audits, and analytics, enabling seamless “Docs as Code” workflows.

A modular system for extracting and converting Python docstrings into useful structured formats like HTML, XML, and TeX. Project inactive. Development taken over by Docutils, http://docutils.sourceforge.net/.

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

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.

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.

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

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.

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.

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

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.

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.

Extracts code from source files for inclusion in documentation.

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.

This is a tutorial about how to create a video player. This tutorial pretends to be a brief introduction to the Graphics User Interfaces (GUI) programming, using the Python programming lenguage and Qt framework, both multiplataform. In this tutorial we'll use PyQt to show you the base of Qt programming under Pyhon. To make this tutorial even more funny, because you can learn the theorical side of Qt programming just reading the documentation, I will focus it only in the practical side, therefore I deside to show you how to create a video player, which its programming is unbelievably simple with Qt. Topics ==== - Useful programming IDEs and tools. - Using Qt Designer for quick GUI design. - Using signals and slots. - Using basic widgets. - Using timers. - Using Phonon multimedia framework. - Using list widgets. - Using stylesheets. (In Progress) - Internationalisation. (In Progress)

PROJECT MOVED TO https://github.com/paulhtremblay/rtf2xml The script rtf2xml faithfully converts Microsoft's RTF format to structured XML. Developers can make further transformations using standard XML tools, or use the stylsheets provided to convert to sdocbook or TEI.

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.