From 61c9186279a00ff3acf99e260e3b2848a6626805 Mon Sep 17 00:00:00 2001 From: Rahul Mahajan Date: Thu, 17 Aug 2023 15:24:28 -0400 Subject: [PATCH] Fix RTD deprecation notice (#1803) This PR: - describes the `requirements.txt` file for RTD documentation deprecation notice described in issue #1798 fixes #1798 --- .pycodestyle | 2 +- .readthedocs.yaml | 4 +++- docs/requirements.txt | 5 ++++- docs/source/conf.py | 12 +++++++++++- 4 files changed, 19 insertions(+), 4 deletions(-) diff --git a/.pycodestyle b/.pycodestyle index 48b90f6208..5907458f78 100644 --- a/.pycodestyle +++ b/.pycodestyle @@ -3,4 +3,4 @@ count = False ignore = E402,W504 max-line-length = 160 statistics = True -exclude = Experimental,.git,.vscode,*.fd,*.cd +exclude = .git,.github,.vscode,venv,*.fd,*.cd,docs/source/conf.py diff --git a/.readthedocs.yaml b/.readthedocs.yaml index fa854552e5..87acd09370 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,7 +15,9 @@ build: sphinx: configuration: docs/source/conf.py +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - requirements: docs/requirements.txt - system_packages: true diff --git a/docs/requirements.txt b/docs/requirements.txt index 9c7258463b..39372ec99d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,5 @@ -sphinxcontrib-bibtex +sphinx sphinx_rtd_theme +sphinxcontrib-bibtex +sphinx-autobuild +sphinx-copybutton diff --git a/docs/source/conf.py b/docs/source/conf.py index c0f9ca572a..89526d9f69 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -80,7 +80,17 @@ # documentation. # # html_theme_options = {} -html_theme_options = {"body_max_width": "none"} +html_theme_options = {"body_max_width": "none", + "footer_icons": [ + {"name": "GitHub", + "url": "https://github.com/NOAA-EMC/global-workflow", + "html": """ + + + + """, + "class": ""}] + } # 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,