Merge pull request #11608 from asgerf/docs/sphinx-python2

Docs: Update README to mention Python 2 requirement
This commit is contained in:
Asger F 2022-12-08 15:36:17 +01:00 коммит произвёл GitHub
Родитель 85ee4e6ca1 f2b99c5fff
Коммит 6fa2fe6c86
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 4 добавлений и 3 удалений

Просмотреть файл

@ -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.