From 98653c068dd10d6fc1d3e96d68238dd6edd943b0 Mon Sep 17 00:00:00 2001 From: Pedro Algarvio Date: Wed, 29 May 2019 11:36:03 +0100 Subject: [PATCH] Allow docs to be built on Python >= 3.5, not just Python 3.6 --- .pre-commit-config.yaml | 18 ++++++++++++++++++ noxfile.py | 7 +++++-- requirements/static/py3.5/docs.txt | 30 ++++++++++++++++++++++++++++++ requirements/static/py3.7/docs.txt | 30 ++++++++++++++++++++++++++++++ 4 files changed, 83 insertions(+), 2 deletions(-) create mode 100644 requirements/static/py3.5/docs.txt create mode 100644 requirements/static/py3.7/docs.txt diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fa1fce9c1ae..831b090620e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -312,6 +312,15 @@ repos: - -v - --py-version=3.5 + - id: pip-tools-compile + alias: compile-doc-requirements + name: Docs Py3.5 Requirements + files: ^requirements/((base|zeromq|pytest)\.txt|static/docs\.in)$ + args: + - -v + - --py-version=3.5 + - --platform=linux + - id: pip-tools-compile alias: compile-linux-py3.6-tcp-requirements name: Linux Py3.6 TCP Requirements @@ -550,3 +559,12 @@ repos: args: - -v - --py-version=3.7 + + - id: pip-tools-compile + alias: compile-doc-requirements + name: Docs Py3.7 Requirements + files: ^requirements/((base|zeromq|pytest)\.txt|static/docs\.in)$ + args: + - -v + - --py-version=3.7 + - --platform=linux diff --git a/noxfile.py b/noxfile.py index 4994ff9bad5..27deca25813 100644 --- a/noxfile.py +++ b/noxfile.py @@ -888,14 +888,17 @@ def lint_tests(session): _lint(session, '.testing.pylintrc', flags, paths) -@nox.session(python='3.6') +@nox.session(python='3') def docs(session): ''' Build Salt's Documentation ''' + pydir = _get_pydir(session) + if pydir == 'py3.4': + session.error('Sphinx only runs on Python >= 3.5') session.install( '--progress-bar=off', - '-r', 'requirements/static/py{}/docs.txt'.format(session.python), + '-r', 'requirements/static/{}/docs.txt'.format(pydir), silent=PIP_INSTALL_SILENT) os.chdir('doc/') session.run('make', 'clean', external=True) diff --git a/requirements/static/py3.5/docs.txt b/requirements/static/py3.5/docs.txt new file mode 100644 index 00000000000..f159bfa46cd --- /dev/null +++ b/requirements/static/py3.5/docs.txt @@ -0,0 +1,30 @@ +# +# This file is autogenerated by pip-compile +# To update, run: +# +# pip-compile -o requirements/static/py3.5/docs.txt -v requirements/static/docs.in +# +alabaster==0.7.12 # via sphinx +babel==2.7.0 # via sphinx +certifi==2019.3.9 # via requests +chardet==3.0.4 # via requests +docutils==0.14 # via sphinx +idna==2.8 # via requests +imagesize==1.1.0 # via sphinx +jinja2==2.10.1 # via sphinx +markupsafe==1.1.1 # via jinja2 +packaging==19.0 # via sphinx +pygments==2.4.2 # via sphinx +pyparsing==2.4.0 # via packaging +pytz==2019.1 # via babel +requests==2.22.0 # via sphinx +six==1.12.0 # via packaging +snowballstemmer==1.2.1 # via sphinx +sphinx==2.0.1 +sphinxcontrib-applehelp==1.0.1 # via sphinx +sphinxcontrib-devhelp==1.0.1 # via sphinx +sphinxcontrib-htmlhelp==1.0.2 # via sphinx +sphinxcontrib-jsmath==1.0.1 # via sphinx +sphinxcontrib-qthelp==1.0.2 # via sphinx +sphinxcontrib-serializinghtml==1.1.3 # via sphinx +urllib3==1.25.3 # via requests diff --git a/requirements/static/py3.7/docs.txt b/requirements/static/py3.7/docs.txt new file mode 100644 index 00000000000..917bdc06faa --- /dev/null +++ b/requirements/static/py3.7/docs.txt @@ -0,0 +1,30 @@ +# +# This file is autogenerated by pip-compile +# To update, run: +# +# pip-compile -o requirements/static/py3.7/docs.txt -v requirements/static/docs.in +# +alabaster==0.7.12 # via sphinx +babel==2.7.0 # via sphinx +certifi==2019.3.9 # via requests +chardet==3.0.4 # via requests +docutils==0.14 # via sphinx +idna==2.8 # via requests +imagesize==1.1.0 # via sphinx +jinja2==2.10.1 # via sphinx +markupsafe==1.1.1 # via jinja2 +packaging==19.0 # via sphinx +pygments==2.4.2 # via sphinx +pyparsing==2.4.0 # via packaging +pytz==2019.1 # via babel +requests==2.22.0 # via sphinx +six==1.12.0 # via packaging +snowballstemmer==1.2.1 # via sphinx +sphinx==2.0.1 +sphinxcontrib-applehelp==1.0.1 # via sphinx +sphinxcontrib-devhelp==1.0.1 # via sphinx +sphinxcontrib-htmlhelp==1.0.2 # via sphinx +sphinxcontrib-jsmath==1.0.1 # via sphinx +sphinxcontrib-qthelp==1.0.2 # via sphinx +sphinxcontrib-serializinghtml==1.1.3 # via sphinx +urllib3==1.25.3 # via requests