Summary

Switch documentation from tbwiki to sphynx (reStructuredText) and readthedocs

Owner

Tim

Reporter

Tim

Status

done

Priority

medium

Description [edit section]

The current PDF documentation is built using tex source and pdflatex.

The current online documentation consists of wiki pages at: http://fuegotest.org/wiki/Documentation

Both of these have issues that we'd like to resolve.

Let's switch to a system that uses rst (reStructuredText) in the fuego repository, that can be built locally using sphynx, and can be built automatically for online use using http://readthedocs.io/

Then, put a link from the fuegotest.org web site to the fuego docs on readthedocs.io.

See rst docs

Notes [edit section]

This is a fairly large project, but should make things better in the long run.

We will keep developer information, release information, FAQ, internal notes and other material on the wiki.

Here is a page with a markup mapping from tbwiki markup to reStructuredText: Markup Mapping

backlink

Fuego Issues List