Package: ansidocs
ansidocsAnsidocs is a command line tool designed to help collate and generate documentation for your Ansible project.See theexample_projectsfolder in this repo for examples of the READMEs generated by this tool.UsageAfter installing the pip package, a command line utility should be available in your virtual environment.To see available options and the help message, simply run:ansidocs# oransidocs-hTo generate documentation for a project in directory/my/project:ansidocsgen-d'/my/project'ConfigurationAnsidocs comes with support for the common Ansible project layouts: roles and collections. You can modify how these projects are processedor create your own project layout by modifying the configuration files.By default, config files are located in your user directory at~/.ansidocs. Files are placed here once the program is run, or by runningthe config generation command:ansidocsconfigYou can forcefully remove this directory and recreate it by using the refresh flag:ansidocsconfig-rCustomizing Project Layouts and READMEsIts possbile to customize or create your own project layout, as well as modify the existing templates used for README generation.Project LayoutsA project layout is a configuration entry that describes where different pieces of your project exist relative to the root directory.Although the types of project parts are limitted to what the program supports, you can add, remove, or move the project parts.To do this, modify the existing configuration file (by default at~/.ansidocs/ansidocs.yml). In that file, there is a dictionarycalledproject_layouts.Note:The meta file attribute is used to link a project layout to your project. So, no layouts should have the same meta filevalue, and the meta file must exist in your project for the program to recognize its layout.An example of the project layout struct can be found in your configuration file.Customizing README TemplatesEach project layout has the option to define a custom README template and add, remove, or reformat data. The templates are found in yourconfiguration directory, (by default at~/.ansidocs/templates). If the program finds a folder with the same name as your layout, it willlook in that directory for templates before falling back to thedefaultsdirectory.When a project's README is rendered, it occurs in 4 stages:render description.md.j2render usage.md.j2render footer.md.j2Compile those renderings as variables, and use them to render README.md.j2Special Documentation FilesIf your project layout defines adocsattribute and that directory exists, ansidocs will look in that directory for certain files and include them in the README generation.Some supported documents include:usage.md- This file will be injected at the top of theUsagesection in your README.md. The file should be pure markdown, there will be no templating or substitution done on this file.description.md- This file will be injected at the top of theDescriptionsection in your README.md. The file should be pure markdown, there will be no templating or substitution done on this file.defaults.yml- This file should contain descriptions for defaults defined in your project, if any. This file is YAML and should match the keys in yourdefaults/main.ymlor corresponding defaults file. Values should be strings that are used as descriptions when compiling the defaults markdown table