Antsibull-docs

Latest version: v2.11.0

Safety actively analyzes 630169 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 7 of 7

0.4.0

======

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

Feature and bugfix release.

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

- Adjust URL escaping to be more similar to JavaScript's ``encodeURI()`` (https://github.com/ansible-community/antsibull-docs-parser/pull/24).
- Also escape ``.`` in MarkDown (https://github.com/ansible-community/antsibull-docs-parser/pull/24).

Bugfixes
--------

- Fix URL escaping in MarkDown (https://github.com/ansible-community/antsibull-docs-parser/pull/24).

0.3.0

======

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

Feature release.

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

- Add support for plain RST rendering (https://github.com/ansible-community/antsibull-docs-parser/pull/20).

0.2.0

======

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

New major release that increases compatibility with the `TypeScript code in antsibull-docs-ts <https://github.com/ansible-community/antsibull-docs-ts>`__.

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

- Add strict mode for parsing (https://github.com/ansible-community/antsibull-docs-parser/pull/15).
- Add support for ansible-doc like text output (https://github.com/ansible-community/antsibull-docs-parser/pull/17).
- Add support for semantic markup in roles (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
- Allow to add markup source to every paragraph part (https://github.com/ansible-community/antsibull-docs-parser/pull/18).
- Can switch between error messages containing a shortened version of the faulty markup or the full faulty markup command (https://github.com/ansible-community/antsibull-docs-parser/pull/19).
- Create script to update/extend the test vectors automatically (https://github.com/ansible-community/antsibull-docs-parser/pull/16).

Breaking Changes / Porting Guide
--------------------------------

- All DOM named tuples now have a ``source`` entry before ``type`` (https://github.com/ansible-community/antsibull-docs-parser/pull/18).
- By default, the error messages now contain the full faulty markup command (https://github.com/ansible-community/antsibull-docs-parser/pull/19).
- Extend ``OptionNamePart`` and ``ReturnValuePart`` named tuples by adding ``entrypoint`` after ``plugin`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
- Modify ``LinkProvider.plugin_option_like_link`` signature to include a new argument ``entrypoint`` after ``plugin`` (https://github.com/ansible-community/antsibull-docs-parser/pull/9).
- ``CommandParser.parse`` has a new ``source`` parameter (https://github.com/ansible-community/antsibull-docs-parser/pull/18).

0.1.0

======

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

Initial release. The ``antsibull-docs`` tool is compatible to the one from antsibull 0.43.0.


antsibull\-docs\-parser \-\- Python library for processing Ansible documentation markup Release Notes

**Topics**

- <a href="v1-0-1">v1\.0\.1</a>
- <a href="release-summary">Release Summary</a>
- <a href="minor-changes">Minor Changes</a>
- <a href="bugfixes">Bugfixes</a>
- <a href="v1-0-0">v1\.0\.0</a>
- <a href="release-summary-1">Release Summary</a>
- <a href="v0-4-0">v0\.4\.0</a>
- <a href="release-summary-2">Release Summary</a>
- <a href="minor-changes-1">Minor Changes</a>
- <a href="bugfixes-1">Bugfixes</a>
- <a href="v0-3-0">v0\.3\.0</a>
- <a href="release-summary-3">Release Summary</a>
- <a href="minor-changes-2">Minor Changes</a>
- <a href="v0-2-0">v0\.2\.0</a>
- <a href="release-summary-4">Release Summary</a>
- <a href="minor-changes-3">Minor Changes</a>
- <a href="breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
- <a href="v0-0-1">v0\.0\.1</a>
- <a href="release-summary-5">Release Summary</a>

<a id="v1-0-1"></a>
v1\.0\.1

<a id="release-summary"></a>
Release Summary

Maintenance release\.

<a id="minor-changes"></a>
Minor Changes

* Declare support for Python 3\.12 \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/45](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/45)\)\.

<a id="bugfixes"></a>
Bugfixes

* Properly escape MarkDown link targets \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/37](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/37)\)\.

<a id="v1-0-0"></a>
v1\.0\.0

<a id="release-summary-1"></a>
Release Summary

First stable release\. This package is using semantic versioning\, so there will be no more breaking changes until the release of 2\.0\.0\.

<a id="v0-4-0"></a>
v0\.4\.0

<a id="release-summary-2"></a>
Release Summary

Feature and bugfix release\.

<a id="minor-changes-1"></a>
Minor Changes

* Adjust URL escaping to be more similar to JavaScript\'s <code>encodeURI\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/24](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/24)\)\.
* Also escape <code>\.</code> in MarkDown \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/24](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/24)\)\.

<a id="bugfixes-1"></a>
Bugfixes

* Fix URL escaping in MarkDown \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/24](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/24)\)\.

<a id="v0-3-0"></a>
v0\.3\.0

<a id="release-summary-3"></a>
Release Summary

Feature release\.

<a id="minor-changes-2"></a>
Minor Changes

* Add support for plain RST rendering \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/20](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/20)\)\.

<a id="v0-2-0"></a>
v0\.2\.0

<a id="release-summary-4"></a>
Release Summary

New major release that increases compatibility with the [TypeScript code in antsibull\-docs\-ts](https\://github\.com/ansible\-community/antsibull\-docs\-ts)\.

<a id="minor-changes-3"></a>
Minor Changes

* Add strict mode for parsing \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/15](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/15)\)\.
* Add support for ansible\-doc like text output \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/17](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/17)\)\.
* Add support for semantic markup in roles \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/9](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/9)\)\.
* Allow to add markup source to every paragraph part \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/18](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/18)\)\.
* Can switch between error messages containing a shortened version of the faulty markup or the full faulty markup command \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/19](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/19)\)\.
* Create script to update/extend the test vectors automatically \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/16](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/16)\)\.

<a id="breaking-changes--porting-guide"></a>
Breaking Changes / Porting Guide

* All DOM named tuples now have a <code>source</code> entry before <code>type</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/18](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/18)\)\.
* By default\, the error messages now contain the full faulty markup command \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/19](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/19)\)\.
* Extend <code>OptionNamePart</code> and <code>ReturnValuePart</code> named tuples by adding <code>entrypoint</code> after <code>plugin</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/9](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/9)\)\.
* Modify <code>LinkProvider\.plugin\_option\_like\_link</code> signature to include a new argument <code>entrypoint</code> after <code>plugin</code> \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/9](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/9)\)\.
* <code>CommandParser\.parse</code> has a new <code>source</code> parameter \([https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/18](https\://github\.com/ansible\-community/antsibull\-docs\-parser/pull/18)\)\.

<a id="v0-0-1"></a>
v0\.0\.1

<a id="release-summary-5"></a>
Release Summary

Initial experimental release\.

0.0.1

======

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

Initial experimental release.


===================================================================
antsibull-docs -- Ansible Documentation Build Scripts Release Notes
===================================================================

.. contents:: Topics

Page 7 of 7

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.