docs: update sphinx version (#5)

12rambau · Apr 11, 2023 · 3b0895e · 3b0895e
2 parents 9a1feff + 2af9e9d
commit 3b0895e
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 948 deletions.
diff --git a/.github/workflows/unit.yaml b/.github/workflows/unit.yaml
@@ -40,8 +40,8 @@ jobs:
         run: pip install .[doc]
       - name: install custom dependencies to avoid known issues
         run: |
-          pip install git+https://github.com/jenshnielsen/sphinx.git@fix_9884
-          pip install git+https://github.com/12rambau/deprecated.git@master
+          pip install git+https://github.com/sphinx-doc/sphinx.git
+          pip install git+https://github.com/12rambau/deprecated.git
           sphinx-apidoc -o docs/api rio_vrt
           sphinx-build -v -b html docs docs/_build/html -w warnings.txt
           python tests/check_warnings.py

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,9 +3,16 @@
 version: 2
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
     python: "3.10"
+  jobs:
+    # patch deprecated and sphinx version to mimic nox build
+    post_install:
+      - pip install git+https://github.com/sphinx-doc/sphinx.git
+      - pip install git+https://github.com/12rambau/deprecated.git
+    pre_build:
+      - sphinx-apidoc -o docs/api rio_vrt
 
 sphinx:
   configuration: docs/conf.py

diff --git a/docs/_static/favicon.svg b/docs/_static/favicon.svg
diff --git a/docs/_static/logo_dark.png b/docs/_static/logo_dark.png
diff --git a/docs/_static/logo_light.png b/docs/_static/logo_light.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,8 +33,6 @@
 html_theme_options = {
     "logo": {
         "text": project,
-        "image_light": "_static/logo_light.png",
-        "image_dark": "static_/logo_dark.png",
     },
     "use_edit_page_button": True,
     "footer_end": ["theme-version", "pypackage-credit"],
@@ -58,7 +56,6 @@
     "doc_path": "docs",
 }
 html_css_files = ["custom.css"]
-html_favicon = "_static/favicon.svg"
 
 # -- Options for autosummary/autodoc output ------------------------------------
 autosummary_generate = True

diff --git a/noxfile.py b/noxfile.py
@@ -27,8 +27,8 @@ def docs(session):
     build = session.posargs.pop() if session.posargs else "html"
     session.install(".[doc]")
     # patch version in nox instead of pyproject to avoid blocking conda releases
-    session.install("git+https://github.com/jenshnielsen/sphinx.git@fix_9884")
-    session.install("git+https://github.com/12rambau/deprecated.git@master")
+    session.install("git+https://github.com/sphinx-doc/sphinx.git")
+    session.install("git+https://github.com/12rambau/deprecated.git")
     session.run("sphinx-apidoc", "-o", "docs/api", "rio_vrt")
     session.run(
         "sphinx-build",