Skip to content

Commit ccd4fce

Browse files
committed
Update Python packages for ReadTheDocs builds
.readthedocs.yaml - Now request Python 3.12 for ReadTheDocs builds docs/requirements.txt - Update to more recent Python package versions for ReadTheDocs builds CHANGELOG.md - Updated accordingly Signed-off-by: Bob Yantosca <[email protected]>
1 parent f807e1a commit ccd4fce

File tree

3 files changed

+20
-15
lines changed

3 files changed

+20
-15
lines changed

.readthedocs.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ version: 2
1414
build:
1515
os: ubuntu-22.04
1616
tools:
17-
python: "3.7"
17+
python: "3.12"
1818
nodejs: "14"
1919
rust: "1.55"
2020
golang: "1.17"

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [Unreleased] - TBD
9+
### Changed
10+
- Updated Python package versions for ReadTheDocs in `docs/requirements.txt`
11+
- Now request Python 3.12 for ReadTheDocs builds in
12+
`.readthedocs.yaml`
13+
814
## [3.8.0] - 2024-02-07
915
### Changed
1016
- Updated TOMAS_Jeagle sea salt extension

docs/requirements.txt

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
# Requirements for building the HEMCO documentation
1+
# ======================================================================
2+
# ReadTheDocs requirements file
23
#
3-
# NOTE: Use specific versions for Python packages instead of upper
4-
# bounds. Using an upper bound will not necessarily install the
5-
# intended version if there already is a version that meets the
6-
# criteria present in the Python environment.
7-
# -- Bob Yantosca and Lizzie Lundgren (30 Jun 2022)
4+
# If you wish to install the dependencies for building the ReadTheDocs
5+
# ReadTheDocs documentation from PyPI (the Python Package Index), use:
86
#
9-
# The following package versions have been proven to work together:
10-
#
11-
sphinx==3.5.4
12-
sphinx_rtd_theme==0.5.2
13-
sphinxcontrib-bibtex==2.2.0
14-
recommonmark
15-
docutils==0.16
16-
jinja2==3.0.3
7+
# $ pip install -r requirements.txt
8+
# ======================================================================
9+
sphinx==7.2.6
10+
sphinx_rtd_theme==2.0.0
11+
sphinxcontrib-bibtex==2.6.2
12+
sphinx-autobuild==2021.3.14
13+
recommonmark==0.7.1
14+
docutils==0.20.1
15+
jinja2==3.1.3

0 commit comments

Comments
 (0)