@@ -26,9 +26,12 @@ Dependencies
26
26
27
27
### HTML documentation
28
28
29
- To produce the complete documentation in HTML, you will need Rocq dependencies
30
- listed in [ ` INSTALL.md ` ] ( ../INSTALL.md ) . Additionally, the Sphinx-based
31
- reference manual requires Python 3, and the following Python packages:
29
+ If you have Nix installed, then the easiest way to get all the dependencies to
30
+ build the refman is to run:
31
+
32
+ nix-shell --argstr job stdlib-refman-html
33
+
34
+ Otherwise, you need to install (in another way) Python 3, and the following Python packages:
32
35
33
36
- sphinx >= 4.5.0
34
37
- sphinx_rtd_theme >= 1.0.0
@@ -37,18 +40,12 @@ reference manual requires Python 3, and the following Python packages:
37
40
- pexpect >= 4.6.0
38
41
- sphinxcontrib-bibtex >= 0.4.2
39
42
40
- To install them , you should first install pip and setuptools (for instance,
41
- with ` apt install python3-pip python3-setuptools ` on Debian / Ubuntu) then run:
43
+ For instance, on Debian / Ubuntu , you can install pip and setuptools
44
+ with ` apt install python3-pip python3-setuptools ` on Debian / Ubuntu then run:
42
45
43
46
pip3 install sphinx sphinx_rtd_theme beautifulsoup4 \
44
47
antlr4-python3-runtime==4.7.1 pexpect sphinxcontrib-bibtex
45
48
46
- Nix users should get the correct development environment to build the
47
- HTML documentation from Rocq's [ ` default.nix ` ] ( ../default.nix ) (more
48
- precisely ` nix-shell --argstr job stdlib-refman-html ` , note this
49
- doesn't include the LaTeX packages needed to build the full
50
- documentation).
51
-
52
49
You can check the dependencies using the ` doc/tools/coqrst/checkdeps.py ` script.
53
50
54
51
### Other formats
0 commit comments