Aliyun Ansible Modules Documentation
This project contains the source code of Module Documentation for Aliyun Ansible.
Follow below instructions to generate documentation from DOCUMENTATION
string in the modules.
Pre-Requisites (Ubuntu OS)
make
utility
Make utility is required to generate html docs. Installmake
utility by running below command on Ubuntu.
sudo apt-get -y install make
python
version 2.7.X
Run below command to installpython
.
sudo apt-get -y install python2.7
Check python installation by running below command.
python --version
- Install
pip
Run below command to installpip
and other packages.
sudo apt-get -y install python-pip python-dev dos2unix
- Install sphinx and theme:
pip install sphinx==1.4.8 sphinx_rtd_theme
Build the documentation
To build module documentation you'll need to run below command in ansible-provider-docs/docs/docsite
folder.
cd docs/docsite
make webdocs
The generated html files are in _build/html/
folder