Ansible-autodoc

Latest version: v0.5.3

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

Scan your dependencies

Page 2 of 2

0.4.0

* Basic functionality with tag annotations working
* simple annotations: "author", "description" and "todo2 also working


Todo

list of documented items to change, solve or improve

issues
* when a yaml file with a special char is templated, an UnicodeEncodeError will be thrown
* Improve test coverage
* add template cli parameter

improvements
* improve the default templates : ongoing task
* improve the documentation : ongoing task
* improve data extraction from annotations: 'example ' requires the to identify the following lines as content
* add autodoc tag, to use as flags for specific templates, i.e autodoc tags:hidden
* add configuration file for defining template include locations, to allow to have multiple include files in a subfolder
to hide the render of tags section
* add annotation personalization by extending annotation definition in configuration file
* document annotation personalization

Page 2 of 2

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.