T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix the recommended Sphinx version.

Browse Source 
The latest Sphinx 1.4.4 produces lots of warnings about four-column indices.
We'll wait for Read the Docs to upgrade their systems before moving to the newer
Sphinx version.
This commit is contained in:
Jakob Stoklund Olesen
2016-07-07 19:24:08 -07:00
parent 84abe28837
commit 6971ae4e40
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@@ -42,8 +42,11 @@ Building the documentation
To build the Cretonne documentation, you need the `Sphinx documentation To build the Cretonne documentation, you need the `Sphinx documentation
generator <http://www.sphinx-doc.org/>`_:: generator <http://www.sphinx-doc.org/>`_::
$ pip install sphinx $ pip install sphinx==1.3.5 sphinx-autobuild
$ cd cretonne/docs $ cd cretonne/docs
$ make html $ make html
$ open _build/html/index.html $ open _build/html/index.html
The specific Sphinx version is currently used by Read the Docs. Sphinx 1.4 has
been released, but produces lots of warnings about four-column indices. We'll
upgrade when Read the Docs does.