Skip to content

Releases: ansible-community/antsibull-docs-ts

0.2.0

02 Apr 19:44

Choose a tag to compare

Release Summary

New major release that increases compatibility with the Python code in antsibull-docs-parser.

Minor Changes

  • Add support for ansible-doc like text output (#36).
  • Add support for semantic markup in roles (#31).
  • Allow to add markup source to every paragraph part (#37).
  • Can switch between error messages containing a shortened version of the faulty markup or the full faulty markup command (#38).
  • Improve error messages by removing superfluous second Error: (#22).
  • Make parsing of P(...) more similar to Python code with respect to error reporting (#22).

Breaking Changes / Porting Guide

  • All DOM parts have a new source property, which must be a string or undefined (#37).
  • By default, the error messages now contain the full faulty markup command (#38).
  • Extend OptionNamePart and ReturnValuePart interfaces by adding entrypoint (ansible-community/antsibull-docs-parser#9).
  • Modify pluginOptionLikeLink signature to include a new argument entrypoint after plugin (#31).
  • Rename only_classic_markup parser option to onlyClassicMarkup (#22).

Bugfixes

  • HTML and MarkDown code: quote HTML command arguments correctly; make sure URLs are correctly quoted (#22).

0.1.0

13 Mar 21:25

Choose a tag to compare

0.1.0 Pre-release
Pre-release

Release Summary

First usable version, including semantic markup support.

Minor Changes

  • Add support for semantic markup (#1).
  • Added MarkDown support (#5).
  • Allow to adjust formatting for HTML, RST, and MarkDown output by allowing to provide formatting functions for every part type (#12).
  • Allow to chose between antsibull-docs like formatting (for Sphinx targets) and plain formatting for HTML (#12).
  • Build both ESM and CommonJS modules for easier consumption in both webpack and node.js projects (#14).
  • Mention paragraph number in error messages when not processing single strings (#11).

Breaking Changes / Porting Guide

  • The package was renamed on npmjs.com from antsibull_docs to antsibull-docs (#15).

Bugfixes

  • Fix error message output for MarkDown. Make sure error message is escaped in RST. Fix error messages when parsing escaped parameters (#8).
  • The parse() option errors's default was exception, and not message as documented. The default is now message (#6).

0.0.1

07 Mar 07:22

Choose a tag to compare

0.0.1 Pre-release
Pre-release

Release Summary

Initial release.