Skip to content

Commit

Permalink
Release 1.7.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Oct 7, 2022
1 parent b9bff5a commit 813da77
Show file tree
Hide file tree
Showing 11 changed files with 62 additions and 18 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,31 @@ antsibull-docs -- Ansible Documentation Build Scripts Release Notes
.. contents:: Topics


v1.7.0
======

Release Summary
---------------

Bugfix and feature release.

Minor Changes
-------------

- Add ``--intersphinx`` option to the ``sphinx-init`` subcommand to allow adding additional ``intersphinx_mapping`` entries to ``conf.py`` (https://github.com/ansible-community/antsibull-docs/issues/35, https://github.com/ansible-community/antsibull-docs/pull/44).
- Allow the ``toctree`` entries for in a collection's ``docs/docsite/extra-docs.yml`` to be a dictionary with ``ref`` and ``title`` keys instead of just a reference as a string (https://github.com/ansible-community/antsibull-docs/pull/45).
- Antsibull-docs now depends on `packaging <https://pypi.org/project/packaging/>`__ (https://github.com/ansible-community/antsibull-docs/pull/49).
- The collection index pages now contain the supported versions of ansible-core of the collection in case collection's ``meta/runtime.yml`` specifies ``requires_ansible`` (https://github.com/ansible-community/antsibull-docs/issues/48, https://github.com/ansible-community/antsibull-docs/pull/49).
- The output of the ``lint-collection-docs`` command has been improved; in particular multi-line messages are now indented (https://github.com/ansible-community/antsibull-docs/pull/52).
- Use ``ansible --version`` to figure out ansible-core version when ansible-core is not installed for the same Python interpreter / venv that is used for antsibull-docs (https://github.com/ansible-community/antsibull-docs/pull/50).
- Use code formatting for all values, such as choice entries, defaults, and samples (https://github.com/ansible-community/antsibull-docs/issues/38, https://github.com/ansible-community/antsibull-docs/pull/42).

Bugfixes
--------

- Avoid long aliases list to make left column too wide (https://github.com/ansible-collections/amazon.aws/issues/1101, https://github.com/ansible-community/antsibull-docs/pull/54).
- Make ``lint-collection-docs --plugin-docs`` subcommand actually work (https://github.com/ansible-community/antsibull-docs/pull/47).

v1.6.1
======

Expand Down
37 changes: 37 additions & 0 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -209,3 +209,40 @@ releases:
- 1.6.1.yml
- 43-version-added.yml
release_date: '2022-09-27'
1.7.0:
changes:
bugfixes:
- Avoid long aliases list to make left column too wide (https://github.com/ansible-collections/amazon.aws/issues/1101,
https://github.com/ansible-community/antsibull-docs/pull/54).
- Make ``lint-collection-docs --plugin-docs`` subcommand actually work (https://github.com/ansible-community/antsibull-docs/pull/47).
minor_changes:
- Add ``--intersphinx`` option to the ``sphinx-init`` subcommand to allow adding
additional ``intersphinx_mapping`` entries to ``conf.py`` (https://github.com/ansible-community/antsibull-docs/issues/35,
https://github.com/ansible-community/antsibull-docs/pull/44).
- Allow the ``toctree`` entries for in a collection's ``docs/docsite/extra-docs.yml``
to be a dictionary with ``ref`` and ``title`` keys instead of just a reference
as a string (https://github.com/ansible-community/antsibull-docs/pull/45).
- Antsibull-docs now depends on `packaging <https://pypi.org/project/packaging/>`__
(https://github.com/ansible-community/antsibull-docs/pull/49).
- The collection index pages now contain the supported versions of ansible-core
of the collection in case collection's ``meta/runtime.yml`` specifies ``requires_ansible``
(https://github.com/ansible-community/antsibull-docs/issues/48, https://github.com/ansible-community/antsibull-docs/pull/49).
- The output of the ``lint-collection-docs`` command has been improved; in particular
multi-line messages are now indented (https://github.com/ansible-community/antsibull-docs/pull/52).
- Use ``ansible --version`` to figure out ansible-core version when ansible-core
is not installed for the same Python interpreter / venv that is used for antsibull-docs
(https://github.com/ansible-community/antsibull-docs/pull/50).
- Use code formatting for all values, such as choice entries, defaults, and
samples (https://github.com/ansible-community/antsibull-docs/issues/38, https://github.com/ansible-community/antsibull-docs/pull/42).
release_summary: Bugfix and feature release.
fragments:
- 1.7.0.yml
- 42-code-rendering.yml
- 44-intersphinx.yml
- 45-extra-docs-toctree.yml
- 47-fix-lint-plugin-docs.yml
- 49-collection-supported-ansible-core.yml
- 50-ansible-version-fallback.yml
- 52-lint-collection-docs-output.yml
- 54-css.yml
release_date: '2022-10-07'
1 change: 0 additions & 1 deletion changelogs/fragments/1.7.0.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/42-code-rendering.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/44-intersphinx.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/45-extra-docs-toctree.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/47-fix-lint-plugin-docs.yml

This file was deleted.

3 changes: 0 additions & 3 deletions changelogs/fragments/49-collection-supported-ansible-core.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/50-ansible-version-fallback.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/52-lint-collection-docs-output.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/54-css.yml

This file was deleted.

0 comments on commit 813da77

Please sign in to comment.