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.

Sign up for GitHub

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

Requirements consolidation #1335

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+23 −18
Open

Requirements consolidation #1335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9c054e
consolidate docs requirements into requirements-dev
bmos Mar 7, 2025
2e9a473
set Sphinx language
bmos Mar 7, 2025
6b0ec01
update docs copyright year
bmos Mar 7, 2025
3dfc505
update circleci workflow to use new requirement and python 3.13
bmos Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ jobs:
# Documentation CI
docs-build:
docker:
- image: cimg/python:3.12
- image: cimg/python:3.13
steps:
- checkout
# Download and cache dependencies
- restore_cache:
keys:
- v2-dependencies-python3.12-{{ checksum "./docs/requirements.txt" }}
- v2-dependencies-python3.13-{{ checksum "requirements-dev.txt" }}
# fallback to using the latest cache if no exact match is found
- v2-dependencies-python3.12-
- v2-dependencies-python3.13-
- run:
name: Install dependencies
# Note that we the circleci node image installs stuff with a user "circleci", rather
Expand All @@ -37,11 +37,12 @@ jobs:
pip install uv
uv venv
source .venv/bin/activate
uv pip install -r ./docs/requirements.txt
uv pip install -r requirements.txt
uv pip install -r requirements-dev.txt
- save_cache:
paths:
- ./venv
key: v2-dependencies-python3.12-{{ checksum "./docs/requirements.txt" }}
key: v2-dependencies-python3.13-{{ checksum "requirements-dev.txt" }}
- run:
name: Build docs
command: |
Expand All @@ -52,15 +53,15 @@ jobs:

docs-build-deploy:
docker:
- image: cimg/python:3.12-node
- image: cimg/python:3.13-node
steps:
- checkout
# Download and cache dependencies
- restore_cache:
keys:
- v2-dependencies-python3.12-{{ checksum "./docs/requirements.txt" }}
- v2-dependencies-python3.13-{{ checksum "requirements-dev.txt" }}-
# fallback to using the latest cache if no exact match is found
- v2-dependencies-python3.12-
- v2-dependencies-python3.13-
- run:
name: Install dependencies
# Note that we the circleci node image installs stuff with a user "circleci", rather
Expand All @@ -71,11 +72,12 @@ jobs:
pip install uv
uv venv
source .venv/bin/activate
uv pip install -r ./docs/requirements.txt
uv pip install -r requirements.txt
uv pip install -r requirements-dev.txt
- save_cache:
paths:
- ./venv
key: v2-dependencies-python3.12-{{ checksum "./docs/requirements.txt" }}
key: v2-dependencies-python3.13-{{ checksum "requirements-dev.txt" }}
- add_ssh_keys:
# This SSH key is "CircleCI Docs" in https://github.com/move-coop/parsons/settings/keys
# We need write access to the Parsons repo, so we can push the "gh-pages" branch.
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
# -- Project information -----------------------------------------------------

project = "Parsons"
copyright = "2019, The Movement Cooperative"
copyright = "2025, The Movement Cooperative"
author = "The Movement Cooperative"

# The short X.Y version
Expand Down Expand Up @@ -68,7 +68,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
5 changes: 0 additions & 5 deletions docs/requirements.txt
View file
Open in desktop

This file was deleted.

10 changes: 9 additions & 1 deletion requirements-dev.txt
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sphinx and myst-parser versions we are using don't support python 3.9.
Allowing last version that did support them.

Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,12 @@ pytest-xdist==3.6.1
pytest==8.3.4
requests-mock==1.12.1
ruff==0.9.4
testfixtures==8.3.0
testfixtures==8.3.0

# Docs Requirements
Sphinx==8.1.3;python_version>='3.10'
Sphinx==7.4.7;python_version<'3.10'
sphinx-rtd-theme==3.0.2
myst-parser==4.0.1;python_version>='3.10'
myst-parser==3.0.1;python_version<'3.10'
sphinx-multiversion
Loading