v1.0.5

Chore

• chore: Update python-semantic-release config (9972341)

  • Add commit types to automatically bump the minor or patch version
    numbers via a commit message.
  • Update commitizen configuration to allow the new commit types.

• chore: Add Python 3.12 to pyproject.toml (ef59c2d)

  This was accidentally omitted in
  6642a17.

• chore: Remove YAPF configuration (ad02127)

  We switched to black back in #5.

Continuous Integration

• ci: pre-commit auto-update (cb014b7)

  updates:

  • github.com/commitizen-tools/commitizen: 3.10.1 → 3.12.0
  • github.com/pre-commit/mirrors-mypy: v1.6.0 → v1.6.1
  • github.com/psf/black: 23.9.1 → 23.10.0
  • github.com/PyCQA/prospector: 1.10.2 → v1.10.3

• ci: pre-commit auto-update (568c816)

  updates:

  • github.com/commitizen-tools/commitizen: 3.10.0 → 3.10.1
  • github.com/pre-commit/mirrors-mypy: v1.5.1 → v1.6.0

• ci: pre-commit auto-update (b57dc9f)

  updates:

  • github.com/pre-commit/pre-commit-hooks: v4.4.0 → v4.5.0

• ci: Add Python 3.12 to CI (f03f4dc)

  Also update the version badge to specify particular versions.

• ci: pre-commit auto-update (d9fc077)

  updates:

  • github.com/commitizen-tools/commitizen: 3.9.0 → 3.10.0

• ci: pre-commit auto-update (e97c276)

  updates:

  • github.com/commitizen-tools/commitizen: 3.8.2 → 3.9.0

• ci: pre-commit auto-update (87d1f7e)

  updates:

  • github.com/commitizen-tools/commitizen: 3.7.1 → 3.8.2
  • github.com/psf/black: 23.7.0 → 23.9.1

• ci: pre-commit auto-update (b750046)

  updates:

  • github.com/commitizen-tools/commitizen: 3.7.0 → 3.7.1

• ci: pre-commit auto-update (b50b368)

  updates:

  • github.com/commitizen-tools/commitizen: 3.6.0 → 3.7.0

• ci: pre-commit auto-update (989ba52)

  updates:

  • github.com/pre-commit/mirrors-mypy: v1.5.0 → v1.5.1

• ci: Fix pre-commit auto-update message (6475b1f)

  Ensure the commit message used by the pre-commit auto-update bot adheres
  to the Conventional Commits specification.

• ci: pre-commit autoupdate (08fe531)

  updates:

  • github.com/commitizen-tools/commitizen: 3.5.3 → 3.6.0
  • github.com/pre-commit/mirrors-mypy: v1.4.1 → v1.5.0
  • github.com/PyCQA/flake8: 6.0.0 → 6.1.0

Documentation

• docs: Remove dependency pinning (b14034f)

  I should be the case that the bugs that kept us on an older version of
  Sphinx have been resolved at this point, so remove the version pinning.

• docs: Add sphinx-copybutton (2122825)

  Automatically add a button to all code boxes to copy the contents to the
  clipboard.

• docs: Fix typos (eb05c2c)

• docs: Special thanks to @mjsumpter (6cc3054)

  Include @mjsumpter in the Credits section at the bottom of the
  README, as he put together a prior iteration of this concept under my
  guidance. His earlier implementation informed the eventual creation of
  this package.

• docs: Add CI details to contributing guidelines (b8269bf)

• docs: Check spelling (b72ee11)

  Add sphinxcontrib-spelling extension to check the spelling in our
  documentation, and add a step to the CI job to ensure all is well.

• docs: Add OpenSSF Best Practices badge (604fb61)

• docs: Fix copy/paste issue (2f6517a)

• docs: pre-commit install instructions (063d8f9)

Patch

• patch: Add release notes template (a447eac)

  • Create a template to govern the generation of release notes by
    python-semantic-release.
  • Bump the patch version number to test that this works as expected.

Test

• test: Run examples in CI (6642a17)

  Create example/test_examples.py so pytest runs all the examples and
  checks their output.