Commit f0d2dba2 authored by Holger Dinkel's avatar Holger Dinkel

update Readme.rst

parent 31fec0b3
No preview for this file type
......@@ -9,18 +9,26 @@ to convert the Markup into HTML and PDF ("Sphinx is a tool that makes it easy to
Sphinx uses ```` for configuration and provides a convenient Makefile for conversion.
Just call ``make html`` (``make singlehtml`` creates one single HTML file), or ``make latexpdf`` to run it.
The resulting documents will be in ``_build/html/`` or ``_build/latex/``, respectively.
Currently, we do not include the HTML output into git, just the PDF and maybe the singlehtml page.
- ReStructuredText
- Sphinx >1.1
- Pygments >1.5
- TexLive >2011
- `ReST Cheat Sheet <>`_
- `ReST and Sphinx Primer <>`_
- `Writing Technical Documentation with Sphinx, Paver, and Cog <>`_
- `using the sffms latex class in sphinx <>`_
PS: I've manually updated the Makefiles to do some minor ``sed`` replacement to use the LaTeX package `fancyvrb <>`_ for styling
the verbatim boxes; this package should be included in the TeXLive distribution.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment