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

Commit

Permalink
update dependencies, as sphinx 4.5 doesn't work on apple silicon (#6)
Browse files Browse the repository at this point in the history
* update dependencies, as sphinx 4.5 doesn't work on apple silicon
  • Loading branch information
Phil Varner authored Feb 1, 2024
1 parent ef9ca25 commit b01d481
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 43 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v2
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
Expand Down
7 changes: 3 additions & 4 deletions .github/workflows/python-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@ jobs:
strategy:
matrix:
python-version:
- '3.7'
- '3.8'
- '3.9'
- '3.10'
- '3.11'
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
10 changes: 7 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic
Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [v0.2.0] - 2023-02-01

### Changed

- upgraded numerous dependencies, including Sphinx to 7.x
- deprecated Python 3.7 and 3.8 support

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

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

Initial release


[Unreleased]: https://github.com/cirrus-geo/cirrus-geo/compare/v0.1.1...main
<!-- [Unreleased]: https://github.com/cirrus-geo/cirrus-geo/compare/v0.1.1...main -->
[v0.2.0]: https://github.com/cirrus-geo/cirrus-geo/cirrus/tree/v0.2.0
[v0.1.1]: https://github.com/cirrus-geo/cirrus-geo/cirrus/tree/v0.1.1
[v0.1.0]: https://github.com/cirrus-geo/cirrus-geo/cirrus/tree/v0.1.0
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ project instance to develop and build documentation, pulling in the docs for
cirrus-geo, cirrus-lib, all of the available components, and any installed
plugins.


## Quickstart

cirrus-docs in `pip`-installable:
Expand All @@ -19,7 +18,7 @@ cirrus-docs in `pip`-installable:
pip install cirrus-docs
```

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:
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:

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


[sphinx]: https://www.sphinx-doc.org/en/master/
[docs]: https://cirrus-geo.github.io/cirrus-docs/
[cirrus-geo]: https://github.com/cirrus-geo/cirrus-geo
Expand Down
6 changes: 3 additions & 3 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pytest~=6.2
pytest-cov~=2.9
flake8~=3.8
pytest~=7.4.4
pytest-cov~=4.1.0
flake8~=7.0.0
2 changes: 1 addition & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sphinx_rtd_theme==1.0.0
sphinx-rtd-theme==2.0.0
12 changes: 6 additions & 6 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cirrus-geo>=0.7.0
sphinx~=4.4
myst_parser~=0.17.0
sphinxcontrib-mermaid~=0.7.1
click-option-group~=0.5.3
sphinx-click~=4.0
cirrus-geo~=0.10.0
sphinx~=7.2.0
myst_parser~=2.0.0
sphinxcontrib-mermaid~=0.9.2
click-option-group~=0.5.6
sphinx-click~=5.1.0
43 changes: 22 additions & 21 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,47 @@
from src.cirrus.plugins.docs.constants import DESC


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


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

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

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


setup(
name=NAME,
packages=find_namespace_packages('src'),
package_dir={'': 'src'},
python_requires=">=3.9",
packages=find_namespace_packages("src"),
package_dir={"": "src"},
version=VERSION,
description=DESC,
long_description=readme,
long_description_content_type='text/markdown',
author='Jarrett Keifer (jkeifer), Element 84',
url='https://github.com/cirrus-geo/cirrus-docs',
long_description_content_type="text/markdown",
author="Jarrett Keifer (jkeifer), Element 84",
url="https://github.com/cirrus-geo/cirrus-docs",
install_requires=install_requires,
dependency_links=dependency_links,
classifiers=[
'Intended Audience :: Developers',
'License :: OSI Approved :: Apache Software License',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9'
classifiers=[
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
],
license='Apache-2.0',
license="Apache-2.0",
include_package_data=True,
entry_points=f'''
entry_points=f"""
[cirrus.plugins]
{NAME}=cirrus.plugins.docs
[cirrus.commands]
docs=cirrus.plugins.docs.commands:docs
''',
""",
)

0 comments on commit b01d481

Please sign in to comment.