aboutsummaryrefslogtreecommitdiffhomepage
path: root/INSTALL.doc
diff options
context:
space:
mode:
authorGravatar Maxime Dénès <mail@maximedenes.fr>2017-02-10 15:52:24 +0100
committerGravatar Maxime Dénès <mail@maximedenes.fr>2018-03-09 15:12:51 +0100
commit4aaf28cc905bebf757b02ad911a6eed78714cac7 (patch)
tree91322ece8b35fc82247938d8a5dc0e70cd22597b /INSTALL.doc
parent1505304e856091e10ff3511edecb9cf7c20974b2 (diff)
Integration of a sphinx-based documentation generator.
The original contribution is from Clément Pit-Claudel. I updated his code and integrated it with the Coq build system. Many improvements by Paul Steckler (MIT). This commit adds the infrastructure but no content.
Diffstat (limited to 'INSTALL.doc')
-rw-r--r--INSTALL.doc10
1 files changed, 10 insertions, 0 deletions
diff --git a/INSTALL.doc b/INSTALL.doc
index 21b21163c..b71115bfa 100644
--- a/INSTALL.doc
+++ b/INSTALL.doc
@@ -26,6 +26,12 @@ To produce all the documents, the following tools are needed:
- convert (ImageMagick)
- hevea
- hacha
+ - Python 3
+ - Sphinx 1.6.5 (http://www.sphinx-doc.org/en/stable/)
+ - sphinx_rtd_theme
+ - pexpect
+ - beautifulsoup4
+ - Antlr4 runtime for Python 3
Under Debian based operating systems (Debian, Ubuntu, ...) a
@@ -34,6 +40,10 @@ working set of packages for compiling the documentation for Coq is:
texlive texlive-latex-extra texlive-math-extra texlive-fonts-extra
texlive-humanities texlive-pictures latex-xcolor hevea transfig
imagemagick
+ python3 python-pip3
+
+To install the Python packages required to build the user manual, run:
+ pip3 install sphinx sphinx_rtd_theme beautifulsoup4 antlr4-python3-runtime pexpect
Compilation