Documentation compilation - SystemAnalysisDpt-CMC-MSU/ellipsoids GitHub Wiki

Installing software

At first, you need to install Sphinx according to this instruction. Sphinx goes as a package for Python, which installation is also described on a page above. Better install Python version 2.7.*. The Sphinx version used to create documentation was 1.2b2. You will also need Sphinx package for numbering figures called numfig, which latest version can be downloaded here. Untar downloaded tarball, open Command Prompt and go to the directory with the *.py files from this tarball, then type: python setup.py install. To get PDF out from the LaTeX sources, you need the latest version of MiKTeX to be installed (can be downloaded from here). Better choose to install packages on-the-fly when asked during the installation. When installation is finished, reboot the computer.

Compilation

To compile documentation, you need to open Windows PowerShell?, go to the main directory of the project, which is \doc\ and:

• to get HTML version, run .\make html,
• to get LaTeX version, run .\make latexpdf. To get PDF, open Command Prompt, go to the \doc\_build\latex, type pdflatex elltool_manual.tex and then once again run this command to get references fixed.

During the compilation sometimes an exception occures connected with numfig. You just need to run make command once again.

Documentation structure is defined in main_manual.rst, some of the additional features can be set in conf.py.