Skip to main content

A lightweight documentation builder.

Project description

## OMDOX

OMDOX is a lightweight documentation builder that utilises [jinja2][0] templates as placeholders for markdown and code.

Code samples are parsed with [pygments][1] and the content is parsed with markdown.

You're in total control of how it looks, feels and responds to different devices.

No magic, it's plain ol' html with a dash of jinja, markdown and pygments.

## Features

### Markdown

All content inside of the {% block content %} is parsed as markdown.


### code


Any blocks of code inside code tags are parsed; eg


```<code lang="bash">
pip install omdox
</code>```


An attempt is made to match the lang attribute against [known pygments lexers][2]. If no match is found it defaults to python.



## Installation

```pip install omdox```

## Usage

1. Make folder for docs
2. Create layout.html inside of docs folder
2. Style as you see fit
3. Create pages that inherit layout.html in docs
5. cd 'docs'
6. run ``omdox``

Your documentation will now be in <docs>/_build

## What about static media?

Proceed as you would building a a normal site. Folders inside of `docs/` get copied into the final build. Just make sure to use relative paths in your html & css.

## Status

Early alpha.

## Issues

Create an issue, I'll be all over it like warm butter on hot bread.

## Known caveats

### Nested Folders

Doesn't support nested folders for docs so `docs/about/this.html` doesn't work. This will get fixed later on.

### Writing Documentation

OMDOX will not make you better at writing documentation, only practice will.

[0]: http://jinja.pocoo.org/docs/
[1]: http://pygments.org/
[2]: http://pygments.org/docs/lexers/

Project details


Release history Release notifications

History Node

0.6.1.alpha

History Node

0.6.0.alpha

History Node

0.5.1.alpha

History Node

0.5.0.alpha

History Node

0.4.3.alpha

History Node

0.4.2.alpha

History Node

0.4.1.alpha

History Node

0.4.0.alpha

History Node

0.3.1.alpha

History Node

0.3.0.alpha

History Node

0.2.4.alpha

History Node

0.2.3.alpha

History Node

0.2.1.alpha

This version
History Node

0.2.0.alpha

History Node

0.1.3.alpha

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
omdox-0.2.0.alpha.tar.gz (4.5 kB) Copy SHA256 hash SHA256 Source None Jul 29, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page