PR #382 for #364 upgrade Sphinx and RTD theme and adapt Sphinx config…

… for RTD Theme
geopython · Jul 19, 2021 · f26afb0 · f26afb0
1 parent a1d00be
commit f26afb0
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 10 deletions.
diff --git a/GeoHealthCheck/plugins/resourceauth/resourceauths.py b/GeoHealthCheck/plugins/resourceauth/resourceauths.py
@@ -81,13 +81,14 @@ def encode_auth_header_val(self):
         """
         Get encoded authorization header value from config data.
         Authorization scheme-specific. ::
-          {
-            'type': 'Basic',
-            'data': {
+
+            {
+              'type': 'Basic',
+              'data': {
                 'username': 'the_user',
                 'password': 'the_password'
-             }
-          }
+              }
+            }
 
         :return: None or http Basic auth header value
         """

diff --git a/docs/conf.py b/docs/conf.py
@@ -32,7 +32,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode', "sphinx_rtd_theme"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/config.rst b/docs/config.rst
@@ -152,7 +152,7 @@ Compiling Language Files
 
 At runtime compiled versions, `.mo` files, of the language-files are used.
 Easiest to compile is via: `paver compile_translations` in the project root dir.
-This basically calls ``pybabel compile` with the proper options.
+This basically calls `pybabel compile` with the proper options.
 Now you can e.g. test your new translations by starting GHC.
 
 Updating Language Files

diff --git a/docs/install.rst b/docs/install.rst
@@ -119,7 +119,7 @@ Notes:
   - assign `Probes` and `Checks` to each `Resource` via the UI
 
 When running with Docker see the
-`Docker Readme <https://github.com/geopython/GeoHealthCheck/blob/master/docker/README.md>`_
+`GHC Docker Readme <https://github.com/geopython/GeoHealthCheck/blob/master/docker/README.md>`_
 how to run `paver upgrade` within your Docker Container.
 
 Upgrade notes v0.5.0

diff --git a/requirements.txt b/requirements.txt
@@ -11,8 +11,8 @@ lxml==4.6.3
 OWSLib==0.20.0
 jsonschema==3.0.2 # downgrade from 3.2.0 on sept 29, 2020, issue 331, consider better fix
 openapi-spec-validator==0.2.8
-Sphinx==3.3.0
-sphinx-rtd-theme==0.5.0
+Sphinx==4.1.1
+sphinx-rtd-theme==0.5.2
 requests>=2.23.0
 WTForms==2.2.1
 APScheduler==3.6.1