hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-28 22:56:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Update README to mention Python 2 requirement

Browse Source
This commit is contained in:
Asger F
2022-12-07 20:24:40 +01:00
parent b5e2e1e469
commit f2b99c5fff
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/codeql/README.rst
View File

@@ -42,9 +42,10 @@ For more information, see
Building and previewing the CodeQL documentation
************************************************
To build and preview the documentation and training presentations locally, you need to
install Sphinx 1.7.9. More recent versions of Sphinx do not work with hieroglyph,
the Sphinx extension that we use to generate HTML slides, as explained below.
To build and preview the documentation and training presentations locally, you need to
install Sphinx 1.7.9 using Python 2 (for example: `pip install sphinx==1.7.9`).
More recent versions of Sphinx do not work with hieroglyph,
the Sphinx extension that we use to generate HTML slides, as explained below.
For installation options, see https://github.com/sphinx-doc/sphinx.