Antsibull-docs

======

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).

======

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

Bugfix release for ansible-core 2.14.

Bugfixes
--------

- Fix formulation of top-level ``version_added`` (https://github.com/ansible-community/antsibull-docs/pull/43).

======

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

Bugfix and feature release.

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

- Allow to specify choices as dictionary instead of list (https://github.com/ansible-community/antsibull-docs/pull/36).
- Use JSON serializer to format choices (https://github.com/ansible-community/antsibull-docs/pull/37).
- Use special serializer to format INI values in examples (https://github.com/ansible-community/antsibull-docs/pull/37).

Bugfixes
--------

- Avoid collection names with ``_`` in them appear wrongly escaped in the HTML output (https://github.com/ansible-community/antsibull-docs/pull/41).
- For INI examples which have no default, write ``VALUE`` as intended instead of ``None`` (https://github.com/ansible-community/antsibull-docs/pull/37).
- Format lists correctly for INI examples (https://github.com/ansible-community/antsibull-docs/pull/37).
- The ``sphinx-init`` subcommand's ``requirement.txt`` file avoids Sphinx 5.2.0.post0, which triggers a bug in sphinx-rtd-theme which happens to be the parent theme of the default theme sphinx_ansible_theme used by ``sphinx-init`` (https://github.com/ansible-community/antsibull-docs/issues/39, https://github.com/ansible-community/antsibull-docs/pull/40).

======

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

Feature and bugfix release.

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

- Detect filter and test plugin aliases and avoid them being emitted multiple times. Instead insert redirects so that stub pages will be created (https://github.com/ansible-community/antsibull-docs/pull/33).
- Replace ``ansible.builtin`` with ``ansible-core``, ``ansible-base``, or ``Ansible`` in version added collection names. Also write ``<collection_name> <version>`` instead of ``<version> of <collection_name>`` (https://github.com/ansible-community/antsibull-docs/pull/34).

Bugfixes
--------

- Fix escaping of collection names in version added statements, and fix collection names for roles options (https://github.com/ansible-community/antsibull-docs/pull/34).

======

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

Feature and bugfix release.

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

- The ``sphinx-init`` subcommand now also creates an ``antsibull-docs.cfg`` file and moves configuration settings from CLI flags in ``build.sh`` to this configuration file (https://github.com/ansible-community/antsibull-docs/pull/26).
- There are two new options for explicitly specified configuration files named ``collection_url`` and ``collection_install``. These allow to override the URLs pointing to collections (default link to galaxy.ansible.com), and the commands to install collections (use ``ansible-galaxy collection install`` by default). This can be useful when documenting (internal) collections that are not available on Ansible Galaxy. The default ``antsibull-docs.cfg`` generated by the ``sphinx-init`` subcommand shows how this can be configured (https://github.com/ansible-community/antsibull-docs/issues/15, https://github.com/ansible-community/antsibull-docs/pull/26).
- When generating plugin error pages, or showing non-fatal errors in plugins or roles, link to the collection's issue tracker instead of the collection's URL if available (https://github.com/ansible-community/antsibull-docs/pull/29).

Bugfixes
--------

- Make handling of bad documentation more robust when certain values are ``None`` while the keys are present (https://github.com/ansible-community/antsibull-docs/pull/32).

======

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

Feature and bugfix release.

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

- Ensure that values for ``default``, ``choices``, and ``sample`` use the types specified for the option / return value (https://github.com/ansible-community/antsibull-docs/pull/19).
- If a plugin or module has requirements listed, add a disclaimer next to the installation line at the top that further requirements are needed (https://github.com/ansible-community/antsibull-docs/issues/23, https://github.com/ansible-community/antsibull-docs/pull/24).
- Show the 'you might already have this collection installed if you are using the ``ansible`` package' disclaimer for plugins only for official docsite builds (subcommands ``devel`` and ``stable``). Also include this disclaimer for roles on official docsite builds (https://github.com/ansible-community/antsibull-docs/pull/25).
- Use ``true`` and ``false`` for booleans instead of ``yes`` and ``no`` (https://github.com/ansible-community/community-topics/issues/116, https://github.com/ansible-community/antsibull-docs/pull/19).
- When processing formatting directives, make sure to properly escape all other text for RST respectively HTML instead of including it verbatim (https://github.com/ansible-community/antsibull-docs/issues/21, https://github.com/ansible-community/antsibull-docs/pull/22).

Bugfixes
--------

- Improve indentation of HTML blocks for tables to avoid edge cases which generate invalid RST (https://github.com/ansible-community/antsibull-docs/pull/22).