Skip to content

Releases: cmsirbu/mkdocs-ansible-collection

v1.1.0

01 Jul 13:57
3cffa42

Choose a tag to compare

This release makes major improvements to the plugin parameters table in line with other ansible documentation sites (see gql_inventory for a detailed showcase) and fixes an ugly display bug for plugin descriptions.

Changed

  • #27 Improved the template that renders the parameters table for plugins:
    • Added data type to the parameter column.
    • Moved env vars to the comments column.
    • Added defaults and choices column to the parameters table.
    • Added suboptions when a parameter has dictionary sub-values.
    • Changed parameters table to inline HTML since Markdown tables break with any errant newlines.

Documentation

  • #27 Added opsmill.infrahub and nokia.srlinux collections to showcase.
  • #27 Fixed page view/edit github links.
  • Added Release Notes and Release Checklist to documentation.

Fixed

  • #23 Fixed template to account for the plugin description not always being a list.

Housekeeping

  • #30 Updated uv to 0.7.17.

v1.0.0

10 May 20:27
d0a425b

Choose a tag to compare

All Ansible plugin types have been enabled and are now rendered with the generic template. While certain plugins would benefit from having dedicated templates, this is now good enough to bump to version 1.0.0!

The project has also moved to uv and now has user and developer documentation.

What's Changed

Features and Docs

  • Enable remaining Ansible plugin types by @cmsirbu in #19
  • Added User and Developer Guides to project docs and simplified README. #21

Housekeeping

  • Update project metadata to allow uv to run alongside poetry 2.0 by @cmsirbu in #11
  • Remove poetry as front-end tool by @cmsirbu in #13
  • Use uv in RTD builds by @cmsirbu in #14
  • Add CI workflow and run.sh tasks file by @cmsirbu in #15
  • Enabled CI testing the mkdocs build on all supported Python versions. #21
  • Enabled strict mode in RTD builds. #21

Full Changelog: v0.2.1...v1.0.0

v0.2.1

16 Nov 14:10
599db12

Choose a tag to compare

What's Changed

  • Fixed issues with HTML escaped YAML in code blocks which broke plugin examples
  • Enable auto-escaping only for html and xml templates by @cmsirbu in #9

Full Changelog: v0.2.0...v0.2.1

v0.2.0

01 Nov 16:10
a219f9c

Choose a tag to compare

What's Changed

  • Add ability to specify collection tree placement in the nav by @cmsirbu in #6
  • Skip disabled plugin types in index pages by @cmsirbu in #7
  • Add quick start steps to README and other instructions by @cmsirbu in #8

Full Changelog: v0.1.4...v0.2.0

v0.1.4

17 Oct 20:53
fd4e3c7

Choose a tag to compare

What's Changed

  • Tweak and use generic plugin template for: filter, lookup, inventory, and module plugins.

Full Changelog: v0.1.3...v0.1.4

v0.1.3

25 Sep 16:30
21979d8

Choose a tag to compare

What's Changed

  • Adds templates. by @jvanderaa in #5
  • Integrate inventory plugin template
  • Tweaked theme width to allow for wider tables on project docs
  • Added networktocode.nautobot collection to project docs example build

New Contributors

Full Changelog: v0.1.2...v0.1.3

v0.1.2

16 Aug 15:38
19deca9

Choose a tag to compare