Skip to content

Commit 5bc13a2

Browse files
committed
Release 0.1.0.
1 parent c4c1d6a commit 5bc13a2

11 files changed

+62
-18
lines changed

CHANGELOG.rst

+29
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,35 @@ antsibull-docs -- TypeScript library for processing Ansible documentation markup
55
.. contents:: Topics
66

77

8+
v0.1.0
9+
======
10+
11+
Release Summary
12+
---------------
13+
14+
First usable version, including semantic markup support.
15+
16+
Minor Changes
17+
-------------
18+
19+
- Add support for semantic markup (https://github.com/ansible-community/antsibull-docs-ts/pull/1).
20+
- Added MarkDown support (https://github.com/ansible-community/antsibull-docs-ts/pull/5).
21+
- Allow to adjust formatting for HTML, RST, and MarkDown output by allowing to provide formatting functions for every part type (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
22+
- Allow to chose between antsibull-docs like formatting (for Sphinx targets) and plain formatting for HTML (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
23+
- Build both ESM and CommonJS modules for easier consumption in both webpack and node.js projects (https://github.com/ansible-community/antsibull-docs-ts/pull/14).
24+
- Mention paragraph number in error messages when not processing single strings (https://github.com/ansible-community/antsibull-docs-ts/pull/11).
25+
26+
Breaking Changes / Porting Guide
27+
--------------------------------
28+
29+
- The package was renamed on npmjs.com from ``antsibull_docs`` to ``antsibull-docs`` (https://github.com/ansible-community/antsibull-docs-ts/pull/15).
30+
31+
Bugfixes
32+
--------
33+
34+
- Fix error message output for MarkDown. Make sure error message is escaped in RST. Fix error messages when parsing escaped parameters (https://github.com/ansible-community/antsibull-docs-ts/pull/8).
35+
- The ``parse()`` option ``errors``'s default was ``exception``, and not ``message`` as documented. The default is now ``message`` (https://github.com/ansible-community/antsibull-docs-ts/pull/6).
36+
837
v0.0.1
938
======
1039

changelogs/changelog.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,36 @@ releases:
66
fragments:
77
- initial-release.yml
88
release_date: '2023-03-07'
9+
0.1.0:
10+
changes:
11+
breaking_changes:
12+
- The package was renamed on npmjs.com from ``antsibull_docs`` to ``antsibull-docs``
13+
(https://github.com/ansible-community/antsibull-docs-ts/pull/15).
14+
bugfixes:
15+
- Fix error message output for MarkDown. Make sure error message is escaped
16+
in RST. Fix error messages when parsing escaped parameters (https://github.com/ansible-community/antsibull-docs-ts/pull/8).
17+
- The ``parse()`` option ``errors``'s default was ``exception``, and not ``message``
18+
as documented. The default is now ``message`` (https://github.com/ansible-community/antsibull-docs-ts/pull/6).
19+
minor_changes:
20+
- Add support for semantic markup (https://github.com/ansible-community/antsibull-docs-ts/pull/1).
21+
- Added MarkDown support (https://github.com/ansible-community/antsibull-docs-ts/pull/5).
22+
- Allow to adjust formatting for HTML, RST, and MarkDown output by allowing
23+
to provide formatting functions for every part type (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
24+
- Allow to chose between antsibull-docs like formatting (for Sphinx targets)
25+
and plain formatting for HTML (https://github.com/ansible-community/antsibull-docs-ts/pull/12).
26+
- Build both ESM and CommonJS modules for easier consumption in both webpack
27+
and node.js projects (https://github.com/ansible-community/antsibull-docs-ts/pull/14).
28+
- Mention paragraph number in error messages when not processing single strings
29+
(https://github.com/ansible-community/antsibull-docs-ts/pull/11).
30+
release_summary: First usable version, including semantic markup support.
31+
fragments:
32+
- 0.1.0.yml
33+
- 1-semantic-markup.yml
34+
- 11-errors.yml
35+
- 12-formatting.yml
36+
- 14-module.yml
37+
- 5-md.yml
38+
- 6-bugs.yml
39+
- 8-fixes.yml
40+
- rename.yml
41+
release_date: '2023-03-13'

changelogs/fragments/0.1.0.yml

-1
This file was deleted.

changelogs/fragments/1-semantic-markup.yml

-2
This file was deleted.

changelogs/fragments/11-errors.yml

-2
This file was deleted.

changelogs/fragments/12-formatting.yml

-3
This file was deleted.

changelogs/fragments/14-module.yml

-2
This file was deleted.

changelogs/fragments/5-md.yml

-2
This file was deleted.

changelogs/fragments/6-bugs.yml

-2
This file was deleted.

changelogs/fragments/8-fixes.yml

-2
This file was deleted.

changelogs/fragments/rename.yml

-2
This file was deleted.

0 commit comments

Comments
 (0)