source: trunk/docs/docs_dev/source/guides/builddoc.rst

Last change on this file was 645, checked in by pinsard, 3 years ago

suppression reference page perso fplod pour les docs

  • Property mime-type set to text/x-rst
File size: 1.3 KB
Line 
1.. +
2..
3.. TODO
4.. =====
5..
6.. translation
7..
8.. doxygen
9..
10.. idldoc
11..
12.. wiki
13..
14.. checklink
15..
16.. EVOLUTIONS
17.. ==========
18..
19.. $Id$
20..
21.. $URL$
22..
23.. - fplod 20140729T100347Z callisto.locean-ipsl.upmc.fr (Linux)
24..
25..   * suppression références page perso fplod
26..
27.. - fplod 20100830T134840Z aedon.locean-ipsl.upmc.fr (Darwin)
28..
29..   * usage of parsed-literal
30..   * inform on restriction for websites update (reserved to fplod)
31..
32.. - fplod 20100603T081607Z aedon.locean-ipsl.upmc.fr (Darwin)
33..
34..   * migration de varamma_doc.xml
35..
36.. -
37
38.. |project| replace:: VARAMMA
39.. |project_id| replace:: varamma
40
41.. _builddoc:
42
43Build Documentation
44-------------------
45
46Documentation |project|
47~~~~~~~~~~~~~~~~~~~~~~~
48
49La documentation est construite à partir des fichiers reStructuredText_
50dans :file:`${PROJECT}/adm/` et des commentaires dans les sources
51sous :file:`${PROJECT}/src/`.
52
53.. _reStructuredText: http://docutils.sourceforge.net/rst.html
54
55Sphinx_ est utilisé pour produire la documentation sous forme HTML et PDF:
56
57.. _Sphinx: http://sphinx.pocoo.org/
58
59.. parsed-literal::
60
61   cd ${|project|}/adm/
62   make clean
63   make before
64   make html_dev
65
66et regarder le résultat dans :file:`../doc/html/index.html`.
67
68Si le résultat est convainquant, on peut produire les autres formats de
69documentations (HTML single, PDF et troff):
70
71.. parsed-literal::
72
73   make all
Note: See TracBrowser for help on using the repository browser.