Maintaining websites or project documentation in HTML is a pain.
rest2web takes out the pain, and brings back the joy.
rest2web is a simple tool that lets you build your website from a single
template (or as many as you want), and keep the contents in ReStructured Text .
(You can still keep pages in HTML if needed.)
It can also aid in having multiple translations of your site (i18n)
and a host of other features.
Below is an index to all the rest2web documentation, but for more information
check out the introduction.
Alternatively, browse the following websites. They are all built with rest2web
and show the range of different styles it is capable of creating :
It also builds the documentation for the following projects :
To see recent changes, visit the Changelog.
- Introduction to rest2web
A gentle introduction to rest2web.
An quick start guide showing how to use rest2web to create a simple website.
The rest2web config file.
An tutorial showing how to use rest2web to create a simple website.
- Command Line Options
The different command line options for rest2web. This includes
passing uservalues for use in your pages and templates.
- Building Websites the Easy Way
A special mode (set from the command line) allows rest2web to build
a website from a collection of ReST documents. In this mode templates,
index pages and restindexes are optional.
A description of templating, and the special values available in the
- The restindex
An explanation of the options and default values in the restindex.
- The Standard Functions
The standard functions for printing indexes, navigation trails, and sidebars.
- Macros in rest2web
The text macro system used by rest2web. Includes documentation on
all the example macros.
- Special Files
A list of all the special filenames that rest2web uses - and what
they are for.
- Reference Section
Documentation and reference for rest2web.
- Test and Example Site
This website tests all the features of rest2web. If it builds
correctly then all is well. It also serves as an illustration of
rest2web, including some of the more obscure options and capabilities.
- Translation Example
A very basic example of a website with multiple translations.
- Example Gallery
Example gallery from the gallery plugin.
(Only present if you build it).