[cig-commits] [commit] master: add sphinx/doc_readme.txt (7b66155)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/burnman

On branch  : master
Link       : https://github.com/geodynamics/burnman/compare/f76fd51b3334a16aae97d4dd7ab1f0204e1d2eb0...c28b39d1cfe942c4cb3b292e4aba88f5850c03a6

>---------------------------------------------------------------

commit 7b6615575a9edcdd340d4345c9e158ee4144a596
Author: Timo Heister <timo.heister at gmail.com>
Date:   Tue Dec 9 15:11:47 2014 -0500

    add sphinx/doc_readme.txt
    
    This file explains how to generate the manual.pdf


>---------------------------------------------------------------

7b6615575a9edcdd340d4345c9e158ee4144a596
 sphinx/doc_readme.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/sphinx/doc_readme.txt b/sphinx/doc_readme.txt
new file mode 100644
index 0000000..3c06d30
--- /dev/null
+++ b/sphinx/doc_readme.txt
@@ -0,0 +1,12 @@
+To build the pdf manual run
+  make latexpdf
+
+required software:
+ sphinx
+ numpydoc (sphinx extension)
+ sphinxcontrib.bibtex (sphinx extension)
+
+
+under linux:
+  sudo apt-get install python-sphinx python-numpydoc
+  sudo pip install sphinxcontrib-bibtex