Documentation Contribution

The documentation is based on Sphinx and hosted on Github Pages.

For documentation editors

Sphinx must be installed on your system. Just follow the directions.

Sphinx file format is ReStructuredText, which is explained on their website: http://sphinx-doc.org/latest/contents.html

The documentation source code has its own project toscadoc. In order to make changes to it, you first need to make a toscadoc clone on your local machine:

git clone https://github.com/tosca-lang/toscadoc.git toscadoc

For publishing on github pages, the best is to checkout the gh-pages branch as a build subdirectory, like this:

toscadoc$ mkdir build
toscadoc$ cd build
toscadoc/build$ git clone https://github.com/tosca-lang/tosca.git html
toscadoc/build$ cd html
toscadoc/build//html$ git checkout gh-pages

Then to generate the html files, use this command:

toscadoc$ make html

which should produce some html files in build/html.

To publish, just commit and push changes to the gh-pages branch:

toscadoc/build/html$ git commit -a
toscadoc/build/html$ git push