README.md

OmpSs Documentation
===================

OmpSs documentation is written using Sphinx

  http://www.sphinx-doc.org/

I want to contribute to the documentation, what do I have to do?
----------------------------------------------------------------

1. Make sure you have sphinx-doc in your machine

    For Ubuntu/Debian distributions:

        $ sudo apt-get install sphinx-doc python-sphinx texlive-latex-extra texlive-fonts-recommended

    (Note: texlive-* packages are required to build PDF documentation)

2. Make changes to .rst files

    Start from index.rst to see the structure. Look at the .. toctree::, it lists
    the included files used to generate the documentation (toctree stands for
    "tree of the table of contents").

    For more information about `reStructuredText` (syntax of .rst), you can
    read a [quick introduction](http://www.sphinx-doc.org/rest.html) or the
    [official documentation](http://docutils.sourceforge.net/rst.html#user-documentation)

3. Generate the documentation (HTML or PDF)
    * Generate the HTML  
    
            $ make html  
    Now open your browser to build/html/index.html and behold your contribution  
    * Generate the PDF
    
            $ make latexpdf  
    Now open your PDF viewer to the build/html/<docfile>.pdf (the file depends on
    the directory you chose in the step 0 above)

4. Commit your changes using git

        $ git commit -a
        $ git push

    It may happen that the remote repository changed where you were editing your local one.
    In that case, first do

        $ git pull --rebase

    and then proceed as above