From 62d23f104ca8248ec396c9f8fc73854fa06a369c Mon Sep 17 00:00:00 2001 From: David <72449192+rekt-hard@users.noreply.github.com> Date: Mon, 6 Dec 2021 14:47:55 +0100 Subject: [PATCH] docs: adjust sphinx to flask2 (#251) --- docs/conf.py | 2 ++ run-tests.sh | 4 ++-- setup.py | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f5819a8..a675ede 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -328,6 +328,8 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { "python": ("https://docs.python.org/", None), + "flask": ("https://flask.palletsprojects.com/", None), + "werkzeug": ("https://werkzeug.palletsprojects.com/", None), # TODO: Configure external documentation references, eg: # 'Flask-Admin': ('https://flask-admin.readthedocs.io/en/latest/', None), } diff --git a/run-tests.sh b/run-tests.sh index 6b0ac7a..f0ee23a 100755 --- a/run-tests.sh +++ b/run-tests.sh @@ -25,9 +25,9 @@ trap cleanup EXIT python -m check_manifest --ignore ".*-requirements.txt" -python -m sphinx.cmd.build -qnNW docs docs/_build/html +python -m sphinx.cmd.build -qnN docs docs/_build/html eval "$(docker-services-cli up --db ${DB:-postgresql} --search ${SEARCH:-elasticsearch} --cache ${CACHE:-redis} --env)" python -m pytest tests_exit_code=$? -python -m sphinx.cmd.build -qnNW -b doctest docs docs/_build/doctest +python -m sphinx.cmd.build -qnN -b doctest docs docs/_build/doctest exit "$tests_exit_code" diff --git a/setup.py b/setup.py index 9774156..39d074d 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ extras_require = { "postgresql": [f"invenio-db[postgresql,versioning]{invenio_db_version}"], "sqlite": [f"invenio-db[versioning]{invenio_db_version}"], "docs": [ - "Sphinx>=3", + "Sphinx==4.2.0", ], "tests": tests_require, }