From 07b6d4692cc4fdb2db38b9f4fa2b8f2162e0677d Mon Sep 17 00:00:00 2001 From: Thomas Grainger Date: Thu, 3 Sep 2020 20:38:22 +0100 Subject: [PATCH] update sphinx and fix sphinx warnings link to the intersphinx inventory https://alnoki.readthedocs.io/en/0.1.0/procedures/sphinx.html#using-intersphinx --- .readthedocs.yml | 11 +++++++++++ docs/conf.py | 3 ++- docs/fixers.rst | 2 +- docs/sphinxext/extra_types.py | 5 ----- setup.cfg | 4 ++++ 5 files changed, 18 insertions(+), 7 deletions(-) delete mode 100644 docs/sphinxext/extra_types.py diff --git a/.readthedocs.yml b/.readthedocs.yml index 22817d2..d611379 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1 +1,12 @@ version: 2 + +sphinx: + fail_on_warning: true + +python: + version: 3.8 + install: + - method: pip + path: . + extra_requirements: + - docs diff --git a/docs/conf.py b/docs/conf.py index f32adf6..0607848 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -98,6 +98,7 @@ "python": ("https://docs.python.org/3", None), "python2": ("https://docs.python.org/2", None), "six": ("https://six.readthedocs.io/", None), + "fissix": ("https://fissix.readthedocs.io/en/latest/", None), } @@ -134,7 +135,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] +html_static_path = [] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/fixers.rst b/docs/fixers.rst index 5c478a4..23ece71 100644 --- a/docs/fixers.rst +++ b/docs/fixers.rst @@ -230,7 +230,7 @@ version of ``six`` is installed. ``fissix`` fixers -+++++++++++++++ ++++++++++++++++++ Some `fixers from fissix `_ in Python's standard library are run by default unmodified as their diff --git a/docs/sphinxext/extra_types.py b/docs/sphinxext/extra_types.py deleted file mode 100644 index 89724ca..0000000 --- a/docs/sphinxext/extra_types.py +++ /dev/null @@ -1,5 +0,0 @@ -from __future__ import generator_stop - - -def setup(app): - app.add_description_unit("2to3fixer", "2to3fixer", "%s (2to3 fixer)") diff --git a/setup.cfg b/setup.cfg index 65f8311..537201b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -30,6 +30,10 @@ console_scripts = modernize = libmodernize.main:main python-modernize = libmodernize.main:main +[options.extras_require] +docs = + sphinx~=3.2 + [bdist_wheel] universal = 1