Skip to content

Commit 6fa2fe6

Browse files
authored
Merge pull request #11608 from asgerf/docs/sphinx-python2
Docs: Update README to mention Python 2 requirement
2 parents 85ee4e6 + f2b99c5 commit 6fa2fe6

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/codeql/README.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ For more information, see
4242
Building and previewing the CodeQL documentation
4343
************************************************
4444

45-
To build and preview the documentation and training presentations locally, you need to
46-
install Sphinx 1.7.9. More recent versions of Sphinx do not work with hieroglyph,
47-
the Sphinx extension that we use to generate HTML slides, as explained below.
45+
To build and preview the documentation and training presentations locally, you need to
46+
install Sphinx 1.7.9 using Python 2 (for example: `pip install sphinx==1.7.9`).
47+
More recent versions of Sphinx do not work with hieroglyph,
48+
the Sphinx extension that we use to generate HTML slides, as explained below.
4849
For installation options, see https://github.com/sphinx-doc/sphinx.
4950

5051

0 commit comments

Comments
 (0)