diff options
| author | Théo Zimmermann | 2020-06-05 15:14:48 +0200 |
|---|---|---|
| committer | Théo Zimmermann | 2020-06-05 15:14:48 +0200 |
| commit | b6c940346123ea9f4e28845436a274c92c9baae6 (patch) | |
| tree | 6067d2471ea1db21abba690ae847130749cd57bb | |
| parent | db768e6828af62e06eb03d36509be6f8fc1efbf3 (diff) | |
Document incompatibility with Sphinx 3.
Cf. #12332
| -rw-r--r-- | doc/README.md | 9 | ||||
| -rw-r--r-- | doc/sphinx/changes.rst | 10 |
2 files changed, 13 insertions, 6 deletions
diff --git a/doc/README.md b/doc/README.md index 8e1bc85c49..e86db61f78 100644 --- a/doc/README.md +++ b/doc/README.md @@ -28,9 +28,10 @@ Dependencies To produce the complete documentation in HTML, you will need Coq dependencies listed in [`INSTALL.md`](../INSTALL.md). Additionally, the Sphinx-based -reference manual requires Python 3, and the following Python packages: +reference manual requires Python 3, and the following Python packages +(note the version constraints on Sphinx): - - sphinx >= 2.3.1 + - sphinx >= 2.3.1 & < 3.0.0 - sphinx_rtd_theme >= 0.4.3 - beautifulsoup4 >= 4.0.6 - antlr4-python3-runtime >= 4.7.1 @@ -40,8 +41,8 @@ reference manual requires Python 3, and the following Python packages: To install them, you should first install pip and setuptools (for instance, with `apt install python3-pip python3-setuptools` on Debian / Ubuntu) then run: - pip3 install sphinx sphinx_rtd_theme beautifulsoup4 antlr4-python3-runtime \ - pexpect sphinxcontrib-bibtex + pip3 install sphinx==2.3.1 sphinx_rtd_theme beautifulsoup4 \ + antlr4-python3-runtime==4.7.1 pexpect sphinxcontrib-bibtex Nix users should get the correct development environment to build the HTML documentation from Coq's [`default.nix`](../default.nix) (note this diff --git a/doc/sphinx/changes.rst b/doc/sphinx/changes.rst index 72f0fdf4c5..68ab36a5ff 100644 --- a/doc/sphinx/changes.rst +++ b/doc/sphinx/changes.rst @@ -970,8 +970,14 @@ Infrastructure and dependencies - **Changed:** Minimal versions of dependencies for building the reference manual: - now requires Sphinx 2.3.1+, sphinx_rtd_theme 0.4.3+ and - sphinxcontrib-bibtex 0.4.2+ + now requires Sphinx >= 2.3.1 & < 3.0.0, sphinx_rtd_theme 0.4.3+ and + sphinxcontrib-bibtex 0.4.2+. + + .. warning:: + + The reference manual is known not to build properly with + Sphinx 3. + (`#12224 <https://github.com/coq/coq/pull/12224>`_, by Jim Fehrle and Théo Zimmermann). - **Removed:** |