doc: add README file about how to build doc

Signed-off-by: Federico Vaga <federico.vaga@cern.ch>

doc: add README file about how to build doc
Signed-off-by: Federico Vaga <federico.vaga@cern.ch>
979767c5 · Federico Vaga · d85b3466 · 979767c5
Commit 979767c5 authored May 24, 2018 by Federico Vaga
Hide whitespace changes
Inline Side-by-side

Showing with 29 additions and 0 deletions

README doc/README +29 -0

No files found.
--- a/doc/README
+++ b/doc/README
+This documentation is based on sphinx. Here a random list of known
+dependencies:
+- doxygen (to extract a database of symbols from the C libraries)
+- GraphViz (to include images)
+- ImageMagick (to include images)
+- Python (to run sphinx)
+  - docutils
+  - sphinx
+  - sphinx_rtd_theme
+
+If you want to generate HTML (suggested), probably the list above it enough.
+
+    make -C doc html
+
+In order to generate the PDF version you need texlive and some extrapackages.
+This really depends on your distribution and how latex packages are packed.
+For this reason we suggest you to download the PDF provided by the Mock Turtle
+team on the official web site, or to adjust your texlive installation according
+to needs.
+
+   make -C doc latexpdf
+
+Here good tips about how to install sphinx:
+
+https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html
+
+
+HTML and PDF are supported and tested, any other format is not directly
+supported.
\ No newline at end of file