Commit c6c3c2db authored by Holger Dinkel's avatar Holger Dinkel

update README

parent 7eae8725
No preview for this file type
...@@ -14,6 +14,7 @@ The resulting documents will be in ``_build/html/`` or ``_build/latex/``, respec ...@@ -14,6 +14,7 @@ The resulting documents will be in ``_build/html/`` or ``_build/latex/``, respec
Currently, we do not include the HTML output into git, just the PDF and maybe the singlehtml page. Currently, we do not include the HTML output into git, just the PDF and maybe the singlehtml page.
Requirements: Requirements:
^^^^^^^^^^^^^
- ReStructuredText https://en.wikipedia.org/wiki/ReStructuredText - ReStructuredText https://en.wikipedia.org/wiki/ReStructuredText
- Sphinx >1.1 http://sphinx-doc.org/ - Sphinx >1.1 http://sphinx-doc.org/
...@@ -21,6 +22,7 @@ Requirements: ...@@ -21,6 +22,7 @@ Requirements:
- TexLive >2011 http://www.tug.org/texlive/ - TexLive >2011 http://www.tug.org/texlive/
Links: Links:
^^^^^^
- `ReST Cheat Sheet <http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html>`_ - `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>`_ - `ReST and Sphinx Primer <http://openmdao.org/dev_docs/documenting/sphinx.html>`_
...@@ -30,5 +32,13 @@ Links: ...@@ -30,5 +32,13 @@ Links:
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 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. the verbatim boxes; this package should be included in the TeXLive distribution.
ToDos:
^^^^^^
- get rid of ``xcolor`` error message in latexpdf
- change Fonts
- Better control of verbatim code-blocks:
- distinguish user input from output (boldface?)
- syntax highlight
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