Skip to content

Commit 638ce4e

Browse files
committed
Update references to obelisk-py
Places where we still referenced CAO, we now reference obelisk-py. The module is renamed to `obelisk` as was previously the case. Docs generator is updated
1 parent 172a090 commit 638ce4e

File tree

68 files changed

+310
-306
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+310
-306
lines changed

.github/workflows/sphinx-documentation.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,14 @@ jobs:
1212
runs-on: ubuntu-latest
1313
name: Sphinx documentation to GitHub pages
1414
steps:
15-
- uses: actions/checkout@v2
15+
- uses: actions/checkout@v4
1616
- name: Installing the library
1717
shell: bash -l {0}
1818
run: |
19-
python setup.py install
20-
pip install -r requirements.txt
21-
pip install sphinx sphinx-rtd-theme recommonmark
19+
curl -LsSf https://astral.sh/uv/install.sh | sh
20+
uv run sphinx-build -M html docs/source/ docs/build/
2221
- name: Deploy
23-
uses: uibcdf/action-sphinx-docs-to-gh-pages@v1.0-beta.2
22+
uses: peaceiris/actions-gh-pages@v4
2423
with:
25-
branch: main
26-
dir_docs: docs
27-
sphinxopts: ''
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
publish_dir: ./docs/build/html

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Construct Additional Obelisks
1+
# Obelisk-Python
22

33
After years of copy-pasting and modifying Obelisk client implementations all over,
44
we've had enough of hearing "construct additional obelisks".
@@ -10,13 +10,14 @@ Take your pick of asynchronous or sync,
1010
import the relevant Producer or Consumer and go crazy.
1111
There is explicitly minimal documentation on actual filter values,
1212
read the [Obelisk docs](https://obelisk.docs.apiary.io/) for that.
13+
Documentation for the Python API can be found [here](https://predict-idlab.github.io/obelisk-python/).
1314

1415
Please never copy the repo into your own project,
15-
rather use `pip install construct-addditional-obelisks`.
16+
rather use `pip install obelisk-py`.
1617

1718
### Retry strategies
1819

19-
Construct Additional Obelisks provides first class support for retry behaviours.
20+
Obelisk-py provides first class support for retry behaviours.
2021
These are defined in `strategies/retry.py`,
2122
we provide `NoRetryStrategy`, `ImmediateRetryStrategy`,
2223
and `ExponentialBackoffRetryStrategy.`

docs/source/_autosummary/construct_additional_obelisks.asynchronous.client.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/source/_autosummary/construct_additional_obelisks.asynchronous.consumer.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/source/_autosummary/construct_additional_obelisks.asynchronous.consumer_test.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/source/_autosummary/construct_additional_obelisks.asynchronous.consumer_test.test_demo_igent.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/source/_autosummary/construct_additional_obelisks.asynchronous.producer.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/source/_autosummary/construct_additional_obelisks.asynchronous.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/source/_autosummary/construct_additional_obelisks.exceptions.AuthenticationError.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/source/_autosummary/construct_additional_obelisks.exceptions.ObeliskError.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)