Skip to content

Commit 52893f0

Browse files
authored
Fix doc generation and PyPI uploads by pinning to Python 3.7 (#500)
* Per the [docs](https://blog.readthedocs.com/migrate-configuration-v2/), ReadTheDocs now requires a `version 2` config file. In it, we pin the version used to generate the docs to Python 3.7, which matches what is currently tested (and green) in CI. * PyPI uploads were still configured to run on the latest version of Python (currently 3.12). We pin this back to Python 3.7, which make it less likely to break in mysterious ways.
1 parent 3173f6e commit 52893f0

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

.github/workflows/pypiupload.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
runs-on: ubuntu-20.04
1313
strategy:
1414
matrix:
15-
python-version: [2.7, 3.x]
15+
python-version: [2.7, 3.7]
1616

1717
steps:
1818
- uses: actions/checkout@v2.3.4
@@ -34,9 +34,9 @@ jobs:
3434
- name: Build
3535
run: |
3636
python setup.py bdist_wheel
37-
- name: Build Sources (3.x)
37+
- name: Build Sources (Python 3)
3838
run: python setup.py sdist
39-
if: matrix.python-version == '3.x'
39+
if: ${{ matrix.python-version != '2.7' }}
4040
- name: Publish
4141
env:
4242
TWINE_USERNAME: __token__

.readthedocs.yml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1-
# .readthedocs.yml
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
24

3-
# Don't build any extra formats
4-
# https://docs.readthedocs.io/en/latest/yaml-config.html#formats
5-
formats: []
5+
version: 2
6+
7+
build:
8+
os: ubuntu-20.04
9+
tools:
10+
python: "3.7"
11+
12+
sphinx:
13+
configuration: docs/conf.py

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454

5555
# General information about the project.
5656
project = u'Dropbox for Python'
57-
copyright = u'2015-2019, Dropbox, Inc.'
57+
copyright = u'2015-2024, Dropbox, Inc.'
5858

5959
# The version info for the project you're documenting, acts as replacement for
6060
# |version| and |release|, also used in various other places throughout the

0 commit comments

Comments
 (0)