Skip to content

Commit

Permalink
Release 2.3.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Jul 9, 2023
1 parent 93ecce0 commit 80bb10b
Show file tree
Hide file tree
Showing 10 changed files with 65 additions and 21 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


v2.3.0
======

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

Bugfix and feature release.

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

- Add a ``:ansplugin:`` role to the Sphinx extension. This allows to reference a module, plugin, or role with the ``fqcn#type`` syntax from semantic markup instead of having to manually compose a ``ansible_collections.{fqcn}_{type}`` label. An explicit reference title can also be provided with the ``title <fqcn#type>`` syntax similar to the ``:ref:`` role (https://github.com/ansible-community/antsibull-docs/pull/180).
- Add a new subcommand ``lint-core-docs`` which lints the ansible-core documentation (https://github.com/ansible-community/antsibull-docs/pull/182).
- Add a new subcommand, ``collection-plugins``, for rendering files for all plugins and roles in a collection without any indexes (https://github.com/ansible-community/antsibull-docs/pull/177).
- Add support for different output formats. Next to the default format, ``ansible-docsite``, a new **experimental** format ``simplified-rst`` is supported. Experimental means that it will likely change considerably in the next few releases until it stabilizes. Such changes will not be considered breaking changes, and could potentially even be bugfixes (https://github.com/ansible-community/antsibull-docs/pull/177).
- Use Dart sass compiler instead of sassc to compile CSS for Sphinx extension (https://github.com/ansible-community/antsibull-docs/issues/185, https://github.com/ansible-community/antsibull-docs/pull/186).
- When parsing errors happen in the Sphinx extension, the extension now emits error messages during the build process in addition to error markup (https://github.com/ansible-community/antsibull-docs/pull/187).

Bugfixes
--------

- Consider module/plugin aliases when linting references to other modules and plugins (https://github.com/ansible-community/antsibull-docs/pull/184).
- Make sure that all aliases are actually listed for plugins (https://github.com/ansible-community/antsibull-docs/pull/183).
- When looking for redirects, the ``aliases`` field and filesystem redirects in ansible-core were not properly considered. This ensures that all redirect stubs are created, and that no duplicates show up, not depending on whether ansible-core is installed in editable mode or not (https://github.com/ansible-community/antsibull-docs/pull/183).

v2.2.0
======

Expand Down
40 changes: 40 additions & 0 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -553,3 +553,43 @@ releases:
- 175-sphinx-ext-nodes.yml
- 2.2.0.yml
release_date: '2023-06-27'
2.3.0:
changes:
bugfixes:
- Consider module/plugin aliases when linting references to other modules and
plugins (https://github.com/ansible-community/antsibull-docs/pull/184).
- Make sure that all aliases are actually listed for plugins (https://github.com/ansible-community/antsibull-docs/pull/183).
- When looking for redirects, the ``aliases`` field and filesystem redirects
in ansible-core were not properly considered. This ensures that all redirect
stubs are created, and that no duplicates show up, not depending on whether
ansible-core is installed in editable mode or not (https://github.com/ansible-community/antsibull-docs/pull/183).
minor_changes:
- Add a ``:ansplugin:`` role to the Sphinx extension. This allows to reference
a module, plugin, or role with the ``fqcn#type`` syntax from semantic markup
instead of having to manually compose a ``ansible_collections.{fqcn}_{type}``
label. An explicit reference title can also be provided with the ``title <fqcn#type>``
syntax similar to the ``:ref:`` role (https://github.com/ansible-community/antsibull-docs/pull/180).
- Add a new subcommand ``lint-core-docs`` which lints the ansible-core documentation
(https://github.com/ansible-community/antsibull-docs/pull/182).
- Add a new subcommand, ``collection-plugins``, for rendering files for all
plugins and roles in a collection without any indexes (https://github.com/ansible-community/antsibull-docs/pull/177).
- Add support for different output formats. Next to the default format, ``ansible-docsite``,
a new **experimental** format ``simplified-rst`` is supported. Experimental
means that it will likely change considerably in the next few releases until
it stabilizes. Such changes will not be considered breaking changes, and could
potentially even be bugfixes (https://github.com/ansible-community/antsibull-docs/pull/177).
- Use Dart sass compiler instead of sassc to compile CSS for Sphinx extension
(https://github.com/ansible-community/antsibull-docs/issues/185, https://github.com/ansible-community/antsibull-docs/pull/186).
- When parsing errors happen in the Sphinx extension, the extension now emits
error messages during the build process in addition to error markup (https://github.com/ansible-community/antsibull-docs/pull/187).
release_summary: Bugfix and feature release.
fragments:
- 177-output-format.yml
- 180-plugin-role.yml
- 182-core-lint.yml
- 183-routing.yml
- 184-lint-routing.yml
- 186-sass.yml
- 187-role-errors.yml
- 2.3.0.yml
release_date: '2023-07-09'
3 changes: 0 additions & 3 deletions changelogs/fragments/177-output-format.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/180-plugin-role.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/182-core-lint.yml

This file was deleted.

5 changes: 0 additions & 5 deletions changelogs/fragments/183-routing.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/184-lint-routing.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/186-sass.yml

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/fragments/187-role-errors.yml

This file was deleted.

3 changes: 0 additions & 3 deletions changelogs/fragments/2.3.0.yml

This file was deleted.

0 comments on commit 80bb10b

Please sign in to comment.