README.md

Documentation Generation

Index

• source: Contains main *.rst files
• tutorials: python script describe how to use the api
• examples: Fury app showcases
• build: Contains the generated documentation

Doc generation steps:

Installing requirements

$ pip install -U -r requirements/default.txt
$ pip install -U -r requirements/optional.txt
$ pip install -U -r requirements/docs.txt

Generate all the Documentation

Go to the docs folder and run the following commands to generate it.

Under Linux and OSX

$ make -C . clean && make -C . html

To generate the documentation without running the examples:

$ make -C . clean && make -C . html-no-examples

Under Windows

$ make clean
$ make html

To generate the documentation without running the examples:

$ make clean
$ make html-no-examples