|
Last change
on this file was
645,
checked in by pinsard, 10 years ago
|
|
suppression reference page perso fplod pour les docs
|
-
Property mime-type set to
text/x-rst
|
|
File size:
1.3 KB
|
| Rev | Line | |
|---|
| [46] | 1 | .. + |
|---|
| 2 | .. |
|---|
| 3 | .. TODO |
|---|
| 4 | .. ===== |
|---|
| 5 | .. |
|---|
| 6 | .. translation |
|---|
| 7 | .. |
|---|
| [120] | 8 | .. doxygen |
|---|
| 9 | .. |
|---|
| [633] | 10 | .. idldoc |
|---|
| [120] | 11 | .. |
|---|
| 12 | .. wiki |
|---|
| 13 | .. |
|---|
| 14 | .. checklink |
|---|
| [633] | 15 | .. |
|---|
| [46] | 16 | .. EVOLUTIONS |
|---|
| 17 | .. ========== |
|---|
| 18 | .. |
|---|
| 19 | .. $Id$ |
|---|
| 20 | .. |
|---|
| [397] | 21 | .. $URL$ |
|---|
| 22 | .. |
|---|
| [645] | 23 | .. - fplod 20140729T100347Z callisto.locean-ipsl.upmc.fr (Linux) |
|---|
| 24 | .. |
|---|
| 25 | .. * suppression références page perso fplod |
|---|
| 26 | .. |
|---|
| [120] | 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 | .. |
|---|
| [46] | 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 | |
|---|
| [120] | 41 | .. _builddoc: |
|---|
| [46] | 42 | |
|---|
| 43 | Build Documentation |
|---|
| [120] | 44 | ------------------- |
|---|
| [46] | 45 | |
|---|
| 46 | Documentation |project| |
|---|
| 47 | ~~~~~~~~~~~~~~~~~~~~~~~ |
|---|
| [645] | 48 | |
|---|
| [636] | 49 | La documentation est construite à partir des fichiers reStructuredText_ |
|---|
| [633] | 50 | dans :file:`${PROJECT}/adm/` et des commentaires dans les sources |
|---|
| [517] | 51 | sous :file:`${PROJECT}/src/`. |
|---|
| [46] | 52 | |
|---|
| [636] | 53 | .. _reStructuredText: http://docutils.sourceforge.net/rst.html |
|---|
| [46] | 54 | |
|---|
| [634] | 55 | Sphinx_ est utilisé pour produire la documentation sous forme HTML et PDF: |
|---|
| [46] | 56 | |
|---|
| [120] | 57 | .. _Sphinx: http://sphinx.pocoo.org/ |
|---|
| [46] | 58 | |
|---|
| [120] | 59 | .. parsed-literal:: |
|---|
| [46] | 60 | |
|---|
| [633] | 61 | cd ${|project|}/adm/ |
|---|
| 62 | make clean |
|---|
| 63 | make before |
|---|
| 64 | make html_dev |
|---|
| [46] | 65 | |
|---|
| [645] | 66 | et regarder le résultat dans :file:`../doc/html/index.html`. |
|---|
| [46] | 67 | |
|---|
| [634] | 68 | Si le résultat est convainquant, on peut produire les autres formats de |
|---|
| [120] | 69 | documentations (HTML single, PDF et troff): |
|---|
| [46] | 70 | |
|---|
| [120] | 71 | .. parsed-literal:: |
|---|
| [46] | 72 | |
|---|
| [633] | 73 | make all |
|---|
Note: See
TracBrowser
for help on using the repository browser.
