This repository contains the documentation for the DIAS project.
The documentation is written in markup language called reStructuredText, often abbreviated as reST.
The link to Getting Started page can be found here.
The link to the syntax of writing in reST can be found here.
Why should we even use this and not Markdown language? here.
A 20-minutes video tutorial can be found here.
Sphinx is a Python-based tool for generating this kind of documentation. Therefore, take the following steps:
Install python if it is not already installed on your machine. Ubuntu 16.04 comes with both python 2 and python 3 already.
Sphinxby typing this in your terminal:
sudo pip3 install sphinx sphinx-autobuild
Create a directory
docswithin your project, and enter this directory
Sphinxmust be configured now. The following command will start the configuration process that is self-explanatory, with many defaults already set.
There are two important settings to be followed:
Separate source and build directories (y/n) [n]: y
Note that you should accept automatic creation of make files since it will save you a lot of time.
The file which you should edit with the documentation is
index.rst. It's location depends on wheather you accepted the defaults or not, but it's either in a
sourcedirectory or directly in
Once you are done editing
index.rst, run the following command to create HTML documentation:
cd docs make html
Generated files are either in
build directory or directly in
docs directory, depending on wheather you chose the default settings.
- Reformat and reorganize the code
- Merge multi-objective aspects with the original code
- check all input parameters, make sure they work
- loggers for repetetive experiments and for single experiments