# Ansible Autodoc Version
A spin of ansible-autodoc that only documents variables
## Install
```sh
pip3 install mod-ansible-autodoc
```
## How to use?
```sh
mod-ansible-autodoc
```
## Optional Args
### Custom titles
There are 4 optional args for this, one per markdown file:
1. --todo-title
2. --actions-title
3. --tags-title
4. --variables-title
The value of an argument has to be wrapped around ''. Example:
```sh
mod-ansible-autodoc --todo-title '## IMPROVEMENTS FILE'
```
### Variables' Title Prefix, Postfix and Example Comment Prefix
It's possible to add a prefix and/or postfix to `ansible_variables.md`'s subheaders and a prefix to the example comment. Simply run:
```sh
mod-ansible-autodoc --variable-title-prefix '###' --variable-title-postfix ' <!-- VARIABLE_FIX -->' --variable-example-comment-prefix '##PREFIX##'
```
Then, expect something like the following:
```
### `sdk_location` <!-- VARIABLE_FIX -->
yaml
##PREFIX## Example implementation of the sdk_location variable
sdk_location: ~/Android/Sdk
```
PyPI 官网下载 | mod-ansible-autodoc-0.5.7.tar.gz
版权申诉
166 浏览量
2022-02-10
15:29:13
上传
评论
收藏 9KB GZ 举报
挣扎的蓝藻
- 粉丝: 12w+
- 资源: 15万+
最新资源
- pta题库答案c语言之排序4统计工龄.zip
- pta题库答案c语言之树结构7堆中的路径.zip
- pta题库答案c语言之树结构3TreeTraversalsAgain.zip
- pta题库答案c语言之树结构2ListLeaves.zip
- pta题库答案c语言之树结构1树的同构.zip
- 基于C++实现民航飞行与地图简易管理系统可执行程序+说明+详细注释.zip
- pta题库答案c语言之复杂度1最大子列和问题.zip
- 三维装箱问题(Three-Dimensional Bin Packing Problem,3D-BPP)是一个经典的组合优化问题
- 以下是一些关于Linux线程同步的基本概念和方法.txt
- 以下是一个简化的示例,它使用pygame库来模拟烟花动画的框架.txt
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈