shakna-israel/docbuilder

Build Python Technical Documentation from Literate Programming Programs

Docbuilder

[ ](https://github.com/shakna-israel/docbuilder/releases)

• Docbuilder is a small python script that will take another Python program, and turn it into documentation.
  • This is the Literate Programming Style
• Docbuilder is used to generate technical documentation. It isn't reccomended at this stage for User Documentation.
• It generates Markdown documents, though it does expect that MKDocs will use it.

Install

From Pip

pip install docbuilder

From Repository

git clone https://github.com/shakna-israel/docbuilder.git
cd docbuilder
python setup.py install

File Download

Docbuilder is actually a single file, so you can copy that to wherever you need to run it.

curl -L https://github.com/shakna-israel/docbuilder/blob/master/docbuilder.py

or

wget --no-check-certificate https://github.com/shakna-israel/docbuilder/blob/master/docbuilder.py

Usage

Check the Public API

Or, if you just want a quickstart:

docbuilder.py -i mypthonlit.pylit -o mydoc

NOTE:

Windows users, ensure you use / to seperate directories. Not \. This may cause unexpected behaviour.

Python Versions

Currently, the supported versions of Python are:

Check Python Compatibility for more information.

Testing

Docbuilder uses nose for testing.

To install everything for testing:

pip install -r tests/dev-requirements.txt