Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Update the docs/requirements.yml to avoid security issues w/ old python versions (used for ReadTheDocs) #265

Closed
1 task done
yantosca opened this issue Mar 14, 2024 · 1 comment
Assignees
Labels
category: Feature Request New feature or request TODO: Documentation Improvements or additions to documentation
Milestone

Comments

@yantosca
Copy link
Contributor

yantosca commented Mar 14, 2024

Name and Institution (Required)

Name: Bob Yantosca
Institution: Harvard + GCST

Confirm you have reviewed the following documentation

New GCClassic feature or discussion

Dependabot found a security issue (https://github.com/geoschem/HEMCO/security/dependabot/1) caused by the version of jinja2 (used to generate ReadTheDocs documentation) having a security vulnerability.

The solution is to update the docs/requirements.txt from:

# Requirements for building the HEMCO documentation
#
# NOTE: Use specific versions for Python packages instead of upper
# bounds.  Using an upper bound will not necessarily install the
# intended version if there already is a version that meets the
# criteria present in the Python environment.
#  -- Bob Yantosca and Lizzie Lundgren (30 Jun 2022)
#
# The following package versions have been proven to work together:
#
sphinx==3.5.4
sphinx_rtd_theme==0.5.2
sphinxcontrib-bibtex==2.2.0
recommonmark
docutils==0.16
jinja2==3.0.3

to

# ======================================================================
# ReadTheDocs requirements file
#
# If you wish to install the dependencies for building the ReadTheDocs
# ReadTheDocs documentation from PyPI (the Python Package Index), use:
#
# $ pip install -r requirements.txt
# ======================================================================
python==3.12
sphinx==7.2.6
sphinx_rtd_theme==2.0.0
sphinxcontrib-bibtex==2.6.2
sphinx-autobuild==2021.3.14
recommonmark==0.7.1
docutils==0.22.1
jinja2==3.1.3

as we have already done for GCPy.

@yantosca yantosca added TODO: Documentation Improvements or additions to documentation category: Feature Request New feature or request labels Mar 14, 2024
@yantosca yantosca self-assigned this Mar 14, 2024
@yantosca yantosca added this to the 3.8.1 milestone Mar 14, 2024
@yantosca
Copy link
Contributor Author

yantosca commented Mar 14, 2024

This update has been made in commit ccd4fce, which is in the docs/dev branch. It can be merged into the GEOS-Chem 14.3.1 / HEMCO 3.8.1 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: Feature Request New feature or request TODO: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant