docs: deprecation notice + fix Read the Docs build#31
Merged
Conversation
This repository is superseded by the aviso-client and aviso-server projects and will be archived. Add prominent deprecation notices and repair documentation publishing so the notice actually ships: - README: warning banner pointing to the new repositories and docs. - docs: global deprecation banner on every page (Sphinx layout override) plus a warning on the landing page. - Read the Docs: add the now-required .readthedocs.yaml (its absence silently skipped builds, leaving the published docs stale), and whitelist it past the .* gitignore rule. - conf.py: read the version from pyaviso/version.py by regex instead of importing pyaviso, whose __init__ pulls in the heavy runtime stack (etcd3, boto3, ...) and made the docs build fragile. Validated with a clean local sphinx-build (exit 0); banner renders on every page; conf.py passes black/isort/flake8.
The deprecation notice needs a release to refresh the PyPI project description, but the publish job gates on a green test matrix that was already failing on main for reasons unrelated to the docs change: - cloudevents 2.x removed the cloudevents.http module, breaking test collection (ModuleNotFoundError: No module named 'cloudevents.http'). Pin cloudevents to <2; 1.x still provides cloudevents.http with the CloudEvent/to_structured/from_http symbols the code imports. - Code QA failed because aviso-server/.../etcd_reporter.py was not black-formatted. Reformat it (whitespace only). Bump the version 1.0.1 -> 1.0.2 and add a What's New entry so the release that carries the deprecation notice is properly versioned.
GitHub has retired the macos-13 (Intel) hosted runners, so the macOS matrix legs queue indefinitely and never complete. That blocks both the PR checks and the release publish job (which gates on the test matrix). This project is deprecated and being archived; Linux coverage is enough to validate the maintenance release that carries the deprecation notice. Drop macOS from both check.yaml and check-publish.yml. The macOS-guarded steps (`if: runner.os == 'macOS'`) remain as harmless no-ops.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This repository is superseded by the re-engineered Aviso projects and will be archived soon. This PR adds prominent deprecation notices and repairs documentation publishing so the notice actually ships to readers.
New home for Aviso:
Changes
> [!WARNING]banner at the top pointing to the new repositories and docs.layout.htmloverride renders a "no longer maintained" admonition on every page, plus a.. warning::on the landing page (index.rst)..readthedocs.yaml(Read the Docs has mandated a config file since 2023; without it the build is silently skipped, which is why the published docs went stale)..*rule in.gitignore(otherwise the dotfile is untracked).conf.py: read the version frompyaviso/version.pyby regex (assetup.pyalready does) instead ofimport pyaviso, whose__init__pulls in the full runtime stack (etcd3,boto3, ...). That import required the whole package to be installed just to build the docs and made the RTD build fragile.Validation
sphinx-build -b html docs/sourcecompletes cleanly (exit 0).Aviso 1.0.1 documentation).conf.pypassesblack,isort(black profile), andflake8(max-line 120, ignore E203).Notes
main(the repo's default branch; there is nodevelopbranch on the remote).reference/triggers.rst(a JSON block with#comments) is unrelated to this change and does not fail the default RTD build.