2.4.0: Improvements to API docs and type annotations

This release has no new functionality, but includes various improvements to API docs (docstrings) and type annotations, as well as a couple of minor bug fixes. Our API reference docs on Read The Docs look nicer, are more consistent, and have better types.

One change that may affect charms that use type checking: the new ops.X syntax will now work with type checkers (Pyright and MyPy) due to adding an explicit __all__ to ops/__init__.py (#937). Oh, and we fixed a bug with relative paths in Container.push_path -- thanks @yanksyoon!

See the full list of PRs merged below.

What's Changed

• Lock docs dependencies; build docs with recent Sphinx version by @benhoyt in #938
• Explicitly add all public ops.X names to __all__ in __init__.py by @benhoyt in #937
• Use Canonical-ish theme from canonical/sphinx-docs-starter-pack by @benhoyt in #941
• Use PurePath type annotation when path casted to string by @carlcsaposs-canonical in #946
• Update Pyright version to latest (1.1.313) by @benhoyt in #944
• Fix sphinx-build warnings and turn warnings into errors by @benhoyt in #942
• Reinstate alertmanager-k8s-operator CI tests now that issue is fixed by @benhoyt in #951
• Remove jargon from and simplify README by @benhoyt in #950
• Fix issue with relative paths in Container.push_path by @yanksyoon in #949
• Avoid error in FileInfo repr due to permissions being None by @benhoyt in #956
• Various docstring and type annotation updates by @benhoyt in #953
• Add "-> None" to methods without other types by @benhoyt in #961

New Contributors

• @carlcsaposs-canonical made their first contribution in #946

Full Changelog: 2.3.0...2.4.0