Generate this documentation

This documentation is generated by the use of Sphinx and Pyreverse. Sphinx uses the Restructured Text format. The following links gives some informations about the syntax:

• Tutorial Sphinx 1.
• Tutorial Sphinx 2.
• Tutorial documentation.
• Tutorial reST.
• Tutorial Napoleon extension.
• Pandoc to convert many formats into reST.

Installation of Sphinx and Pyreverse

For Linux users

sudo apt-get install graphviz graphviz-dev
cd ~/Documents/guitastro/install
python3 -m pip install -r requirements.txt
python3 -m pip install -r requirements_dev.txt

For Windows users

First you must download and install Graphviz.

Open a Powershell as administrator. A quick way to open Powershell as administrator is Win+R (execute commands) and put:

powershell Start-Process powershell -Verb runAs

Then, in the Powershell terminal:

cd C:\Users\xxx\Documents\guitastro\install
python -m pip install -r requirements.txt
python -m pip install -r requirements_dev.txt

Generate the documentation

To generate the documentation you must use the doc_rst batch. It starts to execute pyreverse and then sphinx.

Procedure for Linux. Open a terminal:

cd ~/Documents/guitastro/docs
sh make_doc

make_doc will generate UML diagrams from the Python code, the html and the PDF documentations. To generate only html and pdf documentation, you can use:

cd ~/Documents/guitastro/docs
make html

Procedure for Windows. Open a PowerShell as administrator:

cd C:\Users\xxx\Documents\guitastro\docs
.\make_doc