on master help sign in
Updated README to warn about sphinx version.
commitaf1569c636d08a83aa4f63cb4a5c2b99ca97c172 authorJan de Muijnck-Hughes <jfdm@st-andrews.ac.uk> dateTue 24 Mar 2015, 09:07 (12 years ago) parentfaa95c0
1 file changed+7−1
docs/README.md+7−1
docs/README.md+7−1
@@ -10,7 +10,13 @@ To build the manual the following dependencies must be met. We assume that you h
1010### Sphinx-Doc
1111
1212Python should be installed by default on most systems.
13−Sphinx can be installed wither through your hosts package manager or using pip/easy_install.
13+Sphinx can be installed either through your hosts package manager or using pip/easy_install.
14+
15+*Note* [ReadTheDocs](http://www.readthedocs.org) works with Sphinx
16+ `v1.2.2`. If you install a more recent version of sphinx then
17+ 'incorrectly' marked up documentation may get passed the build system
18+ of readthedocs and be ignored. In the past we had several code-blocks
19+ disappear because of that.
1420
1521### LaTeX
1622