Skip to content
This repository has been archived by the owner on Apr 9, 2021. It is now read-only.

claranet/cloud-deploy-docs

Repository files navigation

Claranet Cloud Deploy documentation

Read the documentation

HTML built version is available online at https://docs.cloud-deploy.io/

Edit the documentation

ReST syntax

ReST syntax is text based as markdown or wiki language.

Install sphinx:

virtualenv sphinx
source sphinx/bin/activate
pip install -r requirements.txt

Edit the targeted source file from source/rst/:

vim source/rst/api.rst

Follow sphinx documentation online.

Generate new doc locally:

make html

Generate Epub:

make html epub

You can read the generated doc from build/html/index.html.