Gp-libs

Breaking change

- Support pytest >8 (29)

- Update doctest pytest plugin for pytest 8.

Development

- ruff 0.2.0

_Maintenance release: no bug fixes or new features._

CI

- Move CodeQL from advanced configuration file to GitHub's default

Development

- ci: Add pydocstyle rule to ruff (28)

Documentation

- Add docstrings to functions, methods, classes, and packages (28)

Development

- poetry: 1.6.1 -> 1.7.0

See also: https://github.com/python-poetry/poetry/blob/1.7.0/CHANGELOG.md

- Move formatting from `black` to [`ruff format`] (27)

This retains the same formatting style of `black` while eliminating a
dev dependency by using our existing rust-based `ruff` linter.

[`ruff format`]: https://docs.astral.sh/ruff/formatter/

- CI: Update action packages to fix warnings

- [dorny/paths-filter]: 2.7.0 -> 2.11.1

[dorny/paths-filter]: https://github.com/dorny/paths-filter

Packaging

- Add Python 3.12 to trove classifiers
- Packaging (poetry): Fix development dependencies

Per [Poetry's docs on managing dependencies] and `poetry check`, we had it wrong: Instead of using extras, we should create these:

toml
[tool.poetry.group.group-name.dependencies]
dev-dependency = "1.0.0"


Which we now do.

[Poetry's docs on managing dependencies]: https://python-poetry.org/docs/master/managing-dependencies/

Fixes

doctest_docutils

- `_from_module`: Backport {func}`functools.cached_property` support (25)

pytest_doctest_docutils

- `pytest_collect_file`: Typing fix (25)

Development

- Use `import typing as t` everywhere (25)

See also: <https://github.com/pytest-dev/pytest/pull/11317>

Packaging

- Move pytest configuration to `pyproject.toml` (24)

Breaking changes

- Python 3.7 Dropped (23)

- _Add your latest changes from PRs here_

New features

- linkify_issues: Automatically link

_conf.py_:

python
issue_url_tpl = 'https://github.com/git-pull/gp-libs/issues/{issue_id}'


- doctest_docutils: :mod:`doctest` w/ docutils support (and markdown)
- doctest_docutils: Support for sphinx-inline-tab's `tab` directive was added in v0.0.1a17 (18)

``markdown
`{tab} example tab

python
>>> 4 + 4
8


`

`{tab} example second

python
>>> 4 + 2
6


`
``

Removed features

- `sphinx_toctree_autodoc_fix` was removed in v0.0.1a12

Overcome by [Sphinx 5.2](https://pypi.org/project/Sphinx/5.2.0) bakes this in by default:

Settings options:

- `add_function_parentheses = False` (default: `True`)
- `toc_object_entries_show_parents` can be (default: `'domain'`):
- `toc_object_entries_show_parents = 'domain'`
- `toc_object_entries_show_parents = 'hide'`
- `toc_object_entries_show_parents = 'all'`

See also:

- https://github.com/sphinx-doc/sphinx/issues/6316
- https://github.com/sphinx-doc/sphinx/pull/10807
- https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f

Documentation

- Initial docs, packaging, etc.

Tests

pytest-doctest-docutils:

- Add tests for pytest conftest.py files (9)

Infrastructure

- Ruff (additional linting rules): Added in 20 and 21
- CI: docutils testgrid (16)
- CI speedups (13)

- Split out release to separate job so the PyPI Upload docker image isn't pulled on normal runs
- Clean up CodeQL

- Poetry: Bump 1.1.x to 1.6.x

<!---
.. vim: set filetype=markdown:
-->