diff --git a/.circleci/config.yml b/.circleci/config.yml index 682c8b0ddb..fc1195268f 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -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 @@ -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: | @@ -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 @@ -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. diff --git a/docs/conf.py b/docs/conf.py old mode 100755 new mode 100644 index d5b37839d7..a529442187 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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. diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 17e537318c..0000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ --r ../requirements.txt -Sphinx==8.1.3 -sphinx-rtd-theme==3.0.2 -myst-parser==4.0.1 -sphinx-multiversion diff --git a/requirements-dev.txt b/requirements-dev.txt index 185be263ed..3aac7fa1e1 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -9,3 +9,11 @@ pytest==8.3.5 requests-mock==1.12.1 ruff==0.9.10 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