Aliyun Ansible 模块文档
本项目包含 Aliyun Ansible 模块文档的源代码。按照以下说明从DOCUMENTATION
模块中的字符串生成文档。
先决条件(Ubuntu 操作系统)
make
实用
程序 生成 html 文档需要 Make 实用程序。make
通过在 Ubuntu 上运行以下命令来安装实用程序。
sudo apt-get -y install make
python
版本 2.7.X
运行下面的命令来安装python
.
sudo apt-get -y install python2.7
通过运行以下命令检查 python 安装。
python --version
- 安装
pip
运行下面的命令来安装pip
和其他包。
sudo apt-get -y install python-pip python-dev dos2unix
- 安装 sphinx 和主题:
pip install sphinx==1.4.8 sphinx_rtd_theme
构建文档
要构建模块文档,您需要在ansible-provider-docs/docs/docsite
文件夹中运行以下命令
cd docs/docsite make webdocs
生成的html文件在_build/html/
文件夹中