Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A lightweight documentation builder.

Project description

## OMDOC

OMDOC 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

### code

Any blocks of code inside code tags are parsed; eg

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


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

### Markdown

Any content inside of ...

```{% markdown %} stuff to mark down {% endmarkdown%} ```

... gets marked down.



## Installation

```pip install omdoc```

## 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 ``omdoc``

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.

## Known caveats

### Nested Folders

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

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

Project details


Download files

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

Files for omdoc, version 0.1.3.alpha
Filename, size File type Python version Upload date Hashes
Filename, size omdoc-0.1.3.alpha.tar.gz (4.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page