Skip to content

Commit

Permalink
Add .readthedocs.yaml, upgrade Python to 3.9 and upgrade package
Browse files Browse the repository at this point in the history
Old version of python was 3.8 or lower, but this isn't supported any more.

To upgrade to 3.9 need to upgrade transifex-client,
as the old version of that we were using isn't supported in 3.9.

If you run pip-compile there are actually layout changes to requirements.txt
but I edited many of them back so we can see that other packages don't
change in this commit.

Need to use an older version of setuptools, or installing dependencies fails

#538
  • Loading branch information
jarofgreen committed Feb 25, 2025
1 parent 3dbc86b commit 643e21a
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 5 deletions.
43 changes: 43 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
apt_packages:
- graphviz
- libgraphviz-dev
tools:
python: "3.9"
jobs:
install:
- pip install setuptools==70
- python -m pip install --exists-action=w --no-cache-dir -r requirements.txt

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements.txt

# You can include or exclude git submodules from the Read the Docs
# documentation build.
# https://docs.readthedocs.io/en/stable/config-file/v2.html#submodules
submodules:
include: all





10 changes: 5 additions & 5 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#
# This file is autogenerated by pip-compile
# To update, run:
# This file is autogenerated by pip-compile with Python 3.9
# by the following command:
#
# pip-compile
# pip-compile requirements.in
#
-e git+https://github.com/OpenDataServices/sphinxcontrib-jsonschema.git@a1e21704186b8e46f161a5b29c3f7bfeace5ca09#egg=sphinxcontrib-jsonschema # via -r requirements.in
-e git+https://github.com/OpenDataServices/sphinxcontrib-opendataservices.git@bc2f9a83a2562a50aa9386fb9c1d30161ed5120e#egg=sphinxcontrib-opendataservices # via -r requirements.in
Expand All @@ -15,7 +15,7 @@ chardet==3.0.4 # via requests
click==7.1.2 # via sphinx-intl
commonmark==0.9.1 # via recommonmark
docutils==0.13.1 # via -r requirements.in, recommonmark, sphinx
git+https://github.com/OpenDataServices/erd-from-json-table-schema.git # via -r requirements.in
erd-from-json-table-schema @ git+https://github.com/OpenDataServices/erd-from-json-table-schema.git # via -r requirements.in
gitdb==4.0.5 # via gitpython
gitpython==3.1.3 # via transifex-client
idna==2.10 # via requests
Expand Down Expand Up @@ -49,7 +49,7 @@ sphinxcontrib-jsmath==1.0.1 # via sphinx
sphinxcontrib-qthelp==1.0.3 # via sphinx
sphinxcontrib-serializinghtml==1.1.4 # via sphinx
text-unidecode==1.3 # via python-slugify
transifex-client==0.13.11 # via -r requirements.in
transifex-client==0.14.4 # via -r requirements.in
urllib3==1.25.9 # via requests, transifex-client

# The following packages are considered to be unsafe in a requirements file:
Expand Down

0 comments on commit 643e21a

Please sign in to comment.