目录

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. Install make utility by running below command on Ubuntu.

    sudo apt-get -y install make 
  • python version 2.7.X

    Run below command to install python.

    sudo apt-get -y install python2.7

    Check python installation by running below command.

    python --version
  • Install pip

    Run below command to install pip 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

邀请码
    Gitlink(确实开源)
  • 加入我们
  • 官网邮箱:gitlink@ccf.org.cn
  • QQ群
  • QQ群
  • 公众号
  • 公众号

版权所有:中国计算机学会技术支持:开源发展技术委员会
京ICP备13000930号-9 京公网安备 11010802032778号