Raw docs imma give it to ya, with no trivia
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docfu
test
.gitattributes
.gitignore
HACKING
LICENSE
README
requirements.txt
setup.py
test.py
tox.ini

README

=====
docfu
=====

    | Shaolin shadowboxing, and the docfu sword style
    | If what you say is true, the Shaolin and the docfu could be dangerous.
    | Do you think your docfu sword can defeat me?
    | En garde, I'll let you try my docfu style.

With docfu you can keep writing your project's documentation in same ol' [Markdown](http://daringfireball.net/projects/markdown/)
(via [python-markdown](https://pypi.python.org/pypi/Markdown)), but you can (optionally) add templating logic
(via [Jinja2](http://jinja.pocoo.org/)).

docfu works when given a directory, git repository (optionally a tag or branch), and shortened GitHub urls (feltnerm/docfu).
This makes it a great tool for a git post-commit hook or as just a regular ol' documentation generator.

docfu is at most alpha status right now. Please post ideas and bugs to the `issue tracker`_.

.. _issue tracker: https://github.com/feltnerm/docfu/issues

Contributions are welcome as well!

Installation:
-------------

    *DUH-DUH-DUH...enter the docfu zone ...*

::

    $ git clone https://github.com/feltnerm/docfu
    $ cd docfu
    $ python setup.py install

Development:
------------

::

    $ git clone https://github.com/feltnerm/docfu
    $ virtualenv docfu-env
    $ source docfu-env/bin/activate
    $ cd docfu
    $ python setup.py install


Usage:
------

   | The game of chess is like a swordfight
   | You must think first before you move
   | Toad style is immensely strong and immune to nearly any weapon
   | When it's properly used it's almost invincible

::

    usage: docfu [-h] [-c CONFIG] [-b BRANCH] [-t TAG] [-r ROOT_DIR]
                 [--assets-dir ASSETS_DIR] [--source-dir SOURCE_DIR]
                 [--temp-dir TEMP_DIR] [--templates-dir TEMPLATES_DIR]
                 [-l LOG_FILE] [-V] [-v] [-d] [-q] [--dev]
                 uri destination

    positional arguments:
      uri                   A URI to a file path, git repository, or github repo.
      destination           Destination for compiled source.

    optional arguments:
      -h, --help            show this help message and exit
      -c CONFIG, --config CONFIG
                            An [optional] configuration file to read.
      -b BRANCH, --branch BRANCH
                            A git branch to checkout.
      -t TAG, --tag TAG     A git tag to checkout.
      -r ROOT_DIR, --root-dir ROOT_DIR
                            Root directory which docs are built from.
      --assets-dir ASSETS_DIR
                            Directory to look for assets (css, js & images) in.
      --source-dir SOURCE_DIR
                            Source directory which to compile from.
      --temp-dir TEMP_DIR   Temporary directory to build docs
      --templates-dir TEMPLATES_DIR
                            Directory to look for Jinja2 templates in.
      -l LOG_FILE, --log-file LOG_FILE
                            File to log to.
      -V, --version         Output verison
      -v, --verbose         Run verbosely or not.
      -d, --debug           Run debugly or not.
      -q, --quiet           Run quietly or not.
      --dev                 Run in production mode or not (send emails on error)

Examples:
---------

   | Straight from the slums of Shaolin
   | docfu Killa B'z on a swarm

Using a git repository url:
~~~~~~~~~~~~~~~~~~~~~~~
``docfu "https://github.com/feltnerm/docfu" "/home/feltnerm/public_html/docs"```

Using a short GitHub url:
~~~~~~~~~~~~~~~~~~~~~~~~~
``docfu "feltnerm/docfu" "/home/feltnerm/public_html/docs"```

Specify directories:
~~~~~~~~~~~~~~~~~~~~~~~
``docfu --root-dir "docs" --source-dir "src" --templates-dir "templates" --assets-dir "assets" feltnerm/docfu" "/home/feltnerm/public_html/docs"``

Docfu a specific tag
~~~~~~~~~~~~~~~~~~~~~~~
``docfu  --tag "0.1" "feltnerm/docfu" "/home/feltnerm/public_html/docs"``

Docfu a specific branch
~~~~~~~~~~~~~~~~~~~~~~~
``docfu  --branch "develop" "feltnerm/docfu" "/home/feltnerm/public_html/docs"``

*From the slums of Shaolin, docfu strikes again*