Skip to content

Commit 61c9186

Browse files
authored
Fix RTD deprecation notice (#1803)
This PR: - describes the `requirements.txt` file for RTD documentation deprecation notice described in issue #1798 fixes #1798
1 parent 8b19f42 commit 61c9186

File tree

4 files changed

+19
-4
lines changed

4 files changed

+19
-4
lines changed

.pycodestyle

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ count = False
33
ignore = E402,W504
44
max-line-length = 160
55
statistics = True
6-
exclude = Experimental,.git,.vscode,*.fd,*.cd
6+
exclude = .git,.github,.vscode,venv,*.fd,*.cd,docs/source/conf.py

.readthedocs.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ build:
1515
sphinx:
1616
configuration: docs/source/conf.py
1717

18+
# Optional but recommended, declare the Python requirements required
19+
# to build your documentation
20+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
1821
python:
1922
install:
2023
- requirements: docs/requirements.txt
21-
system_packages: true

docs/requirements.txt

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1-
sphinxcontrib-bibtex
1+
sphinx
22
sphinx_rtd_theme
3+
sphinxcontrib-bibtex
4+
sphinx-autobuild
5+
sphinx-copybutton

docs/source/conf.py

+11-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,17 @@
8080
# documentation.
8181
#
8282
# html_theme_options = {}
83-
html_theme_options = {"body_max_width": "none"}
83+
html_theme_options = {"body_max_width": "none",
84+
"footer_icons": [
85+
{"name": "GitHub",
86+
"url": "https://github.com/NOAA-EMC/global-workflow",
87+
"html": """
88+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
89+
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
90+
</svg>
91+
""",
92+
"class": ""}]
93+
}
8494

8595
# Add any paths that contain custom static files (such as style sheets) here,
8696
# relative to this directory. They are copied after the builtin static files,

0 commit comments

Comments
 (0)