RenJuan/TASKPM
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add note about how to generate documentation

Browse source
This commit is contained in:
Oscar Gonzalez Fernandez 2013-11-27 19:14:20 +01:00
parent 0a934a952f
commit 930028826d
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
HACKING.rst
View file

@ -275,6 +275,44 @@ openSUSE
# cp CutyCapt /user/bin/cutycapt
LibrePlan documentation generation
----------------------------------
In the doc/src folder you'll find several types of documentation
available: technical documentation, user manual, some training
documentation and training exercises. This documentation is available
in several languages.
The supported outputs are HTML and PDF.
Debian/Ubuntu
~~~~~~~~~~~~~
* Install requirements if generating HTML::
# apt-get install make python-docutils
* Install requirements if generating PDF::
# apt-get install make python-docutils texlive-latex-base texlive-latex-recommended texlive-latex-extra textlive-fonts-recommended
* Go to the directory where the documentation you want to generate
is. For example, if you want to generate the user manual in
English::
# cd doc/src/user/en
* Generate HTML::
# make html
* Generate PDF::
# make pdf
* Generate both formats::
# make
Compilation profiles
--------------------