sphinx-changelog’s Tests

This file tests all valid combinations of the directive.

Towncrier

Sphinx_Changelog 1.5.0 (2024-08-02)

No significant changes.

Towncrier skip-if-empty

Towncrier and rst

Sphinx_Changelog 1.5.0 (2024-08-02)

No significant changes.

Sphinx_Changelog 1.5.1 (2024-01-26)

Backwards Incompatible Changes

  • Increased minimum Python version to 3.8 to match towncrier. (#23)

  • Increased towncrier version to 23.11.0 (#23)

Sphinx_Changelog 1.4.1 (2023-08-02)

Bug Fixes

  • Fix opening towncrier templates. (#21)

Sphinx_Changelog 1.4.0 (2023-08-02)

Features

  • The towncrier version is now pinned to a specific version in sphinx_changelog dependencies. (#17)

  • Update supported version of towncrier to 23.6. (#20)

v1.3.0 (2023-03-01)

Notes

This release pins the version of towncrier to 22.12.0, this is because we rely on private API in towncrier, so changes are needed on every release.

Changes

New Contributors

v1.2.0 (2022-08-31)

Notes

This release requires towncrier 22.8.0

Changes

New Contributors

Full Changelog: https://github.com/OpenAstronomy/sphinx-changelog/compare/v1.1.2…v1.2.0

Sphinx_Changelog v1.1.2 (2021-08-19)

Bug Fixes

  • Explicitly specify encoding when writing changelog. (#11)

  • Fixed rendering to match towncrier, which means that top_line should not be included in the template. (#12)

Sphinx_Changelog v1.1.1 (2021-05-14)

Bug Fixes

  • Re-implement the :towncrier-skip-if-empty: flag as it was dropped in the upgrade to 21.3. (#10)

Sphinx_Changelog v1.1.0 (2021-05-11)

No significant changes.

Sphinx_Changelog 1.1.0rc1 (2021-05-11)

Features

  • Update to support only the latest release of towncrier as there were some substantial changes. (#9)

  • Added support for controlling the title underline used by towncrier in the changelog directive. (#9)

Sphinx_Changelog v1.0.0 (2021-03-16)

No significant changes.

Sphinx_Changelog v0.1rc5 (2021-03-03)

Bug Fixes

  • Do not raise exceptions inside the directive as this can cause the sphinx parallel build to fail. (#8)

Sphinx_Changelog v0.1rc4 (2021-03-02)

Features

  • Add a flag to skip running towncrier if no fragment files are found. (#6)

Bug Fixes

  • Fix resolving paths relative to the file containing the changelog directive. (#6)

Sphinx_Changelog v0.1rc3 (2021-03-02)

Bug Fixes

  • Raise a more helpful error if no towncrier config can be found. (#5)

Sphinx_Changelog v0.1rc2 (2021-03-01)

Features

  • Implement options for changelog backend. Including the existing changelog and towncrier are currently available. (#1)

Bug Fixes

  • Fix use of template and update to parsing code from a newer towncrier version (#3)

Sphinx_Changelog v0.1rc1 (2021-03-01)

Initial implementation copied from sunpy.

Towncrier title level

Sphinx_Changelog 1.5.0 (2024-08-02)

No significant changes.

rst

Sphinx_Changelog 1.5.1 (2024-01-26)

Backwards Incompatible Changes

  • Increased minimum Python version to 3.8 to match towncrier. (#23)

  • Increased towncrier version to 23.11.0 (#23)

Sphinx_Changelog 1.4.1 (2023-08-02)

Bug Fixes

  • Fix opening towncrier templates. (#21)

Sphinx_Changelog 1.4.0 (2023-08-02)

Features

  • The towncrier version is now pinned to a specific version in sphinx_changelog dependencies. (#17)

  • Update supported version of towncrier to 23.6. (#20)

v1.3.0 (2023-03-01)

Notes

This release pins the version of towncrier to 22.12.0, this is because we rely on private API in towncrier, so changes are needed on every release.

Changes

New Contributors

v1.2.0 (2022-08-31)

Notes

This release requires towncrier 22.8.0

Changes

New Contributors

Full Changelog: https://github.com/OpenAstronomy/sphinx-changelog/compare/v1.1.2…v1.2.0

Sphinx_Changelog v1.1.2 (2021-08-19)

Bug Fixes

  • Explicitly specify encoding when writing changelog. (#11)

  • Fixed rendering to match towncrier, which means that top_line should not be included in the template. (#12)

Sphinx_Changelog v1.1.1 (2021-05-14)

Bug Fixes

  • Re-implement the :towncrier-skip-if-empty: flag as it was dropped in the upgrade to 21.3. (#10)

Sphinx_Changelog v1.1.0 (2021-05-11)

No significant changes.

Sphinx_Changelog 1.1.0rc1 (2021-05-11)

Features

  • Update to support only the latest release of towncrier as there were some substantial changes. (#9)

  • Added support for controlling the title underline used by towncrier in the changelog directive. (#9)

Sphinx_Changelog v1.0.0 (2021-03-16)

No significant changes.

Sphinx_Changelog v0.1rc5 (2021-03-03)

Bug Fixes

  • Do not raise exceptions inside the directive as this can cause the sphinx parallel build to fail. (#8)

Sphinx_Changelog v0.1rc4 (2021-03-02)

Features

  • Add a flag to skip running towncrier if no fragment files are found. (#6)

Bug Fixes

  • Fix resolving paths relative to the file containing the changelog directive. (#6)

Sphinx_Changelog v0.1rc3 (2021-03-02)

Bug Fixes

  • Raise a more helpful error if no towncrier config can be found. (#5)

Sphinx_Changelog v0.1rc2 (2021-03-01)

Features

  • Implement options for changelog backend. Including the existing changelog and towncrier are currently available. (#1)

Bug Fixes

  • Fix use of template and update to parsing code from a newer towncrier version (#3)

Sphinx_Changelog v0.1rc1 (2021-03-01)

Initial implementation copied from sunpy.