alibaba/ansible-provider-docs

Name: ansible-provider-docs

Owner: Alibaba

Description: null

Created: 2016-12-30 09:02:05.0

Updated: 2018-03-05 08:00:54.0

Pushed: 2018-01-23 02:36:45.0

Homepage: null

Size: 6529

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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.

   apt-get -y install make 
  

• python version 2.7.X
  
  Run below command to install python.

   apt-get -y install python2.7
  

  Check python installation by running below command.

  on --version
  

• Install pip
  
  Run below command to install pip and other packages.

   apt-get -y install python-pip python-dev dos2unix
  

• Install sphinx and theme:

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.

ocs/docsite
 webdocs 

The generated html files are in _build/html/ folder