Overview of Changes
This section highlights the main changes brought by this release.
-
Generate command-line documentation with sphinx-click (thanks @staticdev)
There is a new Usage page in the Sphinx documentation of generated projects, describing commands, options, and arguments accepted by the command-line interface. This command-line reference is generated using the sphinx-click extension.
-
Combine coverage data on GitHub Actions (thanks @oncleben31)
The Tests workflow on GitHub Actions now has a separate coverage job, which combines the coverage data from test runs on different Python versions and operating systems. Previously, the Tests workflow failed if an individual test run did not reach 100% coverage.
-
Integrate Nox and Poetry using nox-poetry
Nox sessions now use nox-poetry to provide transparent integration with Poetry. Session can be defined in a standard, straightforward way, but use Poetry behind the scenes to build the package and pin dependencies. This removes much boilerplate from
noxfile.py
.
-
Support for Python 3.9
The new major release of the Python programming language is now supported. All checks run on Python 3.9 as well as older supported versions of Python. The default Python version for Nox sessions was bumped from 3.8 to 3.9.
-
Support for Poetry 1.1
The
pyproject.toml
andpoetry.lock
files were migrated to Poetry 1.1.
💥 BREAKING CHANGE 💥 Poetry >= 1.1.0 is now required for development.
Some other important changes:
- Allow generated projects to use
main
as the default repository branch. - Enable code highlighting in
pytest
tracebacks. - Include
xdoctest
in the default checks.
Read on for a complete list of changes.
Changes
This section lists changes affecting generated projects.
🚀 Features
- Generate command-line documentation with sphinx-click (#608) @staticdev
- Combine coverage data with GitHub Action (#568) @oncleben31
- Enable code highlighting with pytest and xdoctest (#460) @cjolowicz
- Enable Nox session for xdoctest by default (#605) @cjolowicz
- Support Python 3.9 (#603) @cjolowicz
- Add nox-poetry (#570, #598) @cjolowicz
- Support
main
branch in Release workflow (#601) @cjolowicz
🪲 Fixes
- Use Read the Docs theme in local builds (#602) @cjolowicz
- Ignore RST201 for compatibility with Google-style docstrings (#591) @cjolowicz
- Do not ignore missing type imports from pytest (#590) @cjolowicz
📦 Dependencies
- Bump actions/cache from v2.1.1 to v2.1.2 (#618) @cjolowicz
- Bump actions/checkout from v2.3.2 to v2.3.3 (#572) @cjolowicz
- Bump actions/setup-python from 2.1.2 to 2.1.3 (#595) @cjolowicz
- Bump actions/setup-python from 2.1.3 to 2.1.4 (#626) @cjolowicz
- Bump darglint from 1.5.4 to 1.5.5 (#586) @cjolowicz
- Bump flake8 from 3.8.3 to 3.8.4 (#584) @cjolowicz
- Bump flake8-rst-docstrings from 0.0.13 to 0.0.14 (#571) @cjolowicz
- Bump mypy from 0.782 to 0.790 (#619) @cjolowicz
- Bump poetry from 1.0.10 to 1.1.2 in /.github/workflows (#588) @cjolowicz
- Bump prettier from 2.1.1 to 2.1.2 (#592) @cjolowicz
- Bump pypa/gh-action-pypi-publish from v1.3.1 to v1.4.1 (#573) @cjolowicz
- Bump pytest from 6.0.2 to 6.1.0 (#574) @cjolowicz
- Bump pytest from 6.1.0 to 6.1.1 (#585) @cjolowicz
- Bump virtualenv from 20.0.31 to 20.0.33 in /.github/workflows (#587) @cjolowicz
- Bump virtualenv from 20.0.33 to 20.0.34 in /.github/workflows (#623) @cjolowicz
- Bump virtualenv from 20.0.34 to 20.0.35 in /.github/workflows (#625) @cjolowicz
- Pin actions/cache to v2.1.1 (#594) @cjolowicz
- Pin actions/upload-artifact to v2.2.0 (#593) @cjolowicz
Changes to the Cookiecutter
This section lists changes to the Cookiecutter that don't affect generated projects.
🚀 Features
- Support Python 3.9 (#604) @cjolowicz
📚 Documentation
- Remove references to master branch from documentation (#610, #614) @cjolowicz
- Move logo to docs directory (#611) @cjolowicz
- Minor improvements to the User Guide (#599, #609) @cjolowicz
📦 Dependencies
- Bump actions/cache from v2.1.1 to v2.1.2 (#617) @dependabot
- Bump actions/checkout from v2.3.2 to v2.3.3 (#549) @dependabot
- Bump actions/setup-python from v2.1.2 to v2.1.3 (#575) @dependabot
- Bump actions/setup-python from v2.1.3 to v2.1.4 (#621) @dependabot
- Bump poetry from 1.0.10 to 1.1.1 in /.github/workflows (#579) @dependabot
- Bump poetry from 1.1.1 to 1.1.2 in /.github/workflows (#582) @dependabot
- Bump prettier from 2.1.1 to 2.1.2 (#596) @cjolowicz
- Bump virtualenv from 20.0.31 to 20.0.32 in /.github/workflows (#577) @dependabot
- Bump virtualenv from 20.0.32 to 20.0.33 in /.github/workflows (#578) @dependabot
- Bump virtualenv from 20.0.33 to 20.0.34 in /.github/workflows (#620) @dependabot