Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ jobs:
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v3
- uses: astral-sh/setup-uv@v6
- run: uv python install
- run: uv run pytest
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ cover/
# Sphinx documentation
docs/_build/
docs/build/
docs/source/_autosummary/

# PyBuilder
.pybuilder/
Expand All @@ -74,6 +75,7 @@ venv/
ENV/
env.bak/
venv.bak/
pyrightconfig.json

# Spyder project settings
.spyderproject
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ Building is as follows:
# uv run sphinx-build -M html docs/source/ docs/build/
```

In case of major restructuring, it may be needed to clean up the contents of `docs/_autosummary` and potentially other rst files in `docs`,
followed by re-running the build.
Manually triggering sphinx-apidoc is unnecessary.

## Credits

Base implementation originally by Pieter Moens <[email protected]>,
Expand Down
37 changes: 0 additions & 37 deletions docs/source/_autosummary/obelisk.asynchronous.client.Client.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/_autosummary/obelisk.asynchronous.client.rst

This file was deleted.

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/_autosummary/obelisk.asynchronous.consumer.rst

This file was deleted.

13 changes: 0 additions & 13 deletions docs/source/_autosummary/obelisk.asynchronous.consumer_test.rst

This file was deleted.

This file was deleted.

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/_autosummary/obelisk.asynchronous.producer.rst

This file was deleted.

17 changes: 0 additions & 17 deletions docs/source/_autosummary/obelisk.asynchronous.rst

This file was deleted.

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_autosummary/obelisk.exceptions.ObeliskError.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/_autosummary/obelisk.exceptions.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/source/_autosummary/obelisk.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading