Skip to content
This repository was archived by the owner on May 3, 2024. It is now read-only.

Commit b01d481

Browse files
author
Phil Varner
authored
update dependencies, as sphinx 4.5 doesn't work on apple silicon (#6)
* update dependencies, as sphinx 4.5 doesn't work on apple silicon
1 parent ef9ca25 commit b01d481

File tree

8 files changed

+45
-43
lines changed

8 files changed

+45
-43
lines changed

.github/workflows/python-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ jobs:
1010
runs-on: ubuntu-latest
1111

1212
steps:
13-
- uses: actions/checkout@v2
13+
- uses: actions/checkout@v4
1414
- name: Set up Python
15-
uses: actions/setup-python@v2
15+
uses: actions/setup-python@v5
1616
with:
1717
python-version: '3.x'
1818
- name: Install dependencies

.github/workflows/python-test.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,15 @@ jobs:
1212
strategy:
1313
matrix:
1414
python-version:
15-
- '3.7'
16-
- '3.8'
1715
- '3.9'
1816
- '3.10'
17+
- '3.11'
1918
runs-on: ubuntu-latest
2019
steps:
2120
- name: Checkout
22-
uses: actions/checkout@v2
21+
uses: actions/checkout@v4
2322
- name: Set up Python ${{ matrix.python-version }}
24-
uses: actions/setup-python@v1
23+
uses: actions/setup-python@v5
2524
with:
2625
python-version: ${{ matrix.python-version }}
2726
- name: Install dependencies

CHANGELOG.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
66
and this project adheres to [Semantic
77
Versioning](http://semver.org/spec/v2.0.0.html).
88

9-
## [Unreleased]
9+
## [v0.2.0] - 2023-02-01
1010

11+
### Changed
12+
13+
- upgraded numerous dependencies, including Sphinx to 7.x
14+
- deprecated Python 3.7 and 3.8 support
1115

1216
## [v0.1.1] - 2022-09-13
1317

@@ -19,7 +23,7 @@ Versioning](http://semver.org/spec/v2.0.0.html).
1923

2024
Initial release
2125

22-
23-
[Unreleased]: https://github.com/cirrus-geo/cirrus-geo/compare/v0.1.1...main
26+
<!-- [Unreleased]: https://github.com/cirrus-geo/cirrus-geo/compare/v0.1.1...main -->
27+
[v0.2.0]: https://github.com/cirrus-geo/cirrus-geo/cirrus/tree/v0.2.0
2428
[v0.1.1]: https://github.com/cirrus-geo/cirrus-geo/cirrus/tree/v0.1.1
2529
[v0.1.0]: https://github.com/cirrus-geo/cirrus-geo/cirrus/tree/v0.1.0

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ project instance to develop and build documentation, pulling in the docs for
1010
cirrus-geo, cirrus-lib, all of the available components, and any installed
1111
plugins.
1212

13-
1413
## Quickstart
1514

1615
cirrus-docs in `pip`-installable:
@@ -19,7 +18,7 @@ cirrus-docs in `pip`-installable:
1918
pip install cirrus-docs
2019
```
2120

22-
When installed alonside [cirrus-geo], it will add a `docs` subcommand to the `cirrus` cli, which can be used within a cirrus project to initialize, stage, and build the project documentation:
21+
When installed alongside [cirrus-geo], it will add a `docs` subcommand to the `cirrus` cli, which can be used within a Cirrus project to initialize, stage, and build the project documentation:
2322

2423
```
2524
~ ❯ cd project-dir
@@ -31,7 +30,6 @@ When installed alonside [cirrus-geo], it will add a `docs` subcommand to the `ci
3130
cirrus-docs is built on top of [sphinx]. See the [full plugin
3231
documentation][docs] for more information about how to use it.
3332

34-
3533
[sphinx]: https://www.sphinx-doc.org/en/master/
3634
[docs]: https://cirrus-geo.github.io/cirrus-docs/
3735
[cirrus-geo]: https://github.com/cirrus-geo/cirrus-geo

requirements-dev.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
pytest~=6.2
2-
pytest-cov~=2.9
3-
flake8~=3.8
1+
pytest~=7.4.4
2+
pytest-cov~=4.1.0
3+
flake8~=7.0.0

requirements-docs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
sphinx_rtd_theme==1.0.0
1+
sphinx-rtd-theme==2.0.0

requirements.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
cirrus-geo>=0.7.0
2-
sphinx~=4.4
3-
myst_parser~=0.17.0
4-
sphinxcontrib-mermaid~=0.7.1
5-
click-option-group~=0.5.3
6-
sphinx-click~=4.0
1+
cirrus-geo~=0.10.0
2+
sphinx~=7.2.0
3+
myst_parser~=2.0.0
4+
sphinxcontrib-mermaid~=0.9.2
5+
click-option-group~=0.5.6
6+
sphinx-click~=5.1.0

setup.py

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,46 +7,47 @@
77
from src.cirrus.plugins.docs.constants import DESC
88

99

10-
NAME = 'cirrus-docs'
10+
NAME = "cirrus-docs"
1111
HERE = os.path.abspath(os.path.dirname(__file__))
12-
VERSION = os.environ.get('PLUGIN_VERSION', '0.0.0')
12+
VERSION = os.environ.get("PLUGIN_VERSION", "0.0.0")
1313

1414

15-
with open(os.path.join(HERE, 'README.md'), encoding='utf-8') as f:
15+
with open(os.path.join(HERE, "README.md"), encoding="utf-8") as f:
1616
readme = f.read()
1717

18-
with open(os.path.join(HERE, 'requirements.txt'), encoding='utf-8') as f:
19-
reqs = f.read().split('\n')
18+
with open(os.path.join(HERE, "requirements.txt"), encoding="utf-8") as f:
19+
reqs = f.read().split("\n")
2020

21-
install_requires = [x.strip() for x in reqs if 'git+' not in x]
22-
dependency_links = [x.strip().replace('git+', '') for x in reqs if 'git+' not in x]
21+
install_requires = [x.strip() for x in reqs if "git+" not in x]
22+
dependency_links = [x.strip().replace("git+", "") for x in reqs if "git+" not in x]
2323

2424

2525
setup(
2626
name=NAME,
27-
packages=find_namespace_packages('src'),
28-
package_dir={'': 'src'},
27+
python_requires=">=3.9",
28+
packages=find_namespace_packages("src"),
29+
package_dir={"": "src"},
2930
version=VERSION,
3031
description=DESC,
3132
long_description=readme,
32-
long_description_content_type='text/markdown',
33-
author='Jarrett Keifer (jkeifer), Element 84',
34-
url='https://github.com/cirrus-geo/cirrus-docs',
33+
long_description_content_type="text/markdown",
34+
author="Jarrett Keifer (jkeifer), Element 84",
35+
url="https://github.com/cirrus-geo/cirrus-docs",
3536
install_requires=install_requires,
3637
dependency_links=dependency_links,
37-
classifiers=[
38-
'Intended Audience :: Developers',
39-
'License :: OSI Approved :: Apache Software License',
40-
'Programming Language :: Python :: 3.7',
41-
'Programming Language :: Python :: 3.8',
42-
'Programming Language :: Python :: 3.9'
38+
classifiers=[
39+
"Intended Audience :: Developers",
40+
"License :: OSI Approved :: Apache Software License",
41+
"Programming Language :: Python :: 3.9",
42+
"Programming Language :: Python :: 3.10",
43+
"Programming Language :: Python :: 3.11",
4344
],
44-
license='Apache-2.0',
45+
license="Apache-2.0",
4546
include_package_data=True,
46-
entry_points=f'''
47+
entry_points=f"""
4748
[cirrus.plugins]
4849
{NAME}=cirrus.plugins.docs
4950
[cirrus.commands]
5051
docs=cirrus.plugins.docs.commands:docs
51-
''',
52+
""",
5253
)

0 commit comments

Comments
 (0)