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 ``conf.py`` 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.
Links/Requirements:
Requirements:
- ReStructuredText https://en.wikipedia.org/wiki/ReStructuredText
- Sphinx >1.1 http://sphinx-doc.org/
- Pygments >1.5 http://pygments.org/
- TexLive >2011 http://www.tug.org/texlive/
Links:
- `ReST Cheat Sheet <http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html>`_
- `ReST and Sphinx Primer <http://openmdao.org/dev_docs/documenting/sphinx.html>`_
- `Writing Technical Documentation with Sphinx, Paver, and Cog <http://doughellmann.com/2009/02/writing-technical-documentation-with-sphinx-paver-and-cog.html>`_
- `using the sffms latex class in sphinx <http://sphinx.pocoo.org/extensions.html http://www.goer.org/Journal/2011/01/publishing_with_sphinx_rest_and_sffms_latex.html>`_
PS: I've manually updated the Makefiles to do some minor ``sed`` replacement to use the LaTeX package `fancyvrb <http://www.ctan.org/pkg/fancyvrb>`_ for styling
the verbatim boxes; this package should be included in the TeXLive distribution.
Holger
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