How it works?

RstForge takes reStructuredText files from your code repository, and use it to provide a website for your application.

It can also handle Ditz (unmaintened) or Bugs Everywhere to integrate a view of current issues.

By example, with this repository structure:

project1/
    README.rst
    www/
        index.rst
        somepage.rst

project2/
    TODO.rst
    www/
        index.rst

RstForge will build this page hierarchy:

/                           Index of all projects with a www/ folder

/project1/                  Page generated from project1/www/index.rst
/project1/somepage/         Page generated from project1/www/somepage.rst
/project1/code/README.rst   Page generated from part of source code

/project2/                  Page generated from project2/www/index.rst
/project2/code/TODO.rst

Another example is... the www/ folder of RstForge, which give... this site.

Get the code

Download it with Bazaar:

$ bzr branch http://code.filyb.info/rstforge/

or through the web interface.

RstForge is distributed under the terms of the AGPL license 3 or greater.

Documentation

• Read the read-me.

Utilities

• The forgeup script placed on a server allow to update a bazaar repository and generate the BE or Ditz bug output on one command (it can also patch it to use the rstforge css).
• The bzr_forgeup.py Bazaar plugin hooks bzr push to automatically run forgeup on the server. If you set up your own RstForge, feel free to edit constants at the top of the file to match your configuration.
• The forgepreview script lets developer localy preview a web page generated from a rst file.
• The rstforge css is the css stylesheet used here.

Bugs and suggestions

• Please contact me.