Changeset 517 for trunk/docs

Timestamp:

04/13/12 12:58:01 (12 years ago)

Author:

pinsard

Message:

consolidation of doc dev. (to be cont.)

Location:

trunk/docs/docs_dev

Files:

• Makefile (modified) (3 diffs)
• makefile_non_sphinx (modified) (4 diffs)
• source/conf.py (modified) (2 diffs)
• source/guides/builddoc.rst (modified) (2 diffs)
• source/index_guides.rst (modified) (1 diff)

trunk/docs/docs_dev/Makefile

@@ -2 +2 @@
 #
 # .. _Makefile:
+#
 # ========
 # Makefile
@@ -10 +11 @@
 #
 # Makefile for Sphinx documentation
-# 
+#
 # SEE ALSO
 # ========
@@ -17 +18 @@
 #
 # :ref:`makefile_non_sphinx`
-# 
+#
 # TODO
 # ====
 #
-# moins bourrin dans l'usage de makefile_non_sphinx et la génération du 
+# moins bourrin dans l'usage de makefile_non_sphinx et la génération du
 # logo
 #
 # update whith new sphinx backend
-# 
+#
 # EVOLUTIONS
 # ==========
-# 
+#
 # $Id: Makefile 30 2012-03-13 10:53:33Z pinsard $
 #
 # $URL: svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/fptools/svn/trunk/docs/docs_dev/Makefile $
-# 
+#
 # - fplod 20120413T082638Z cratos (Linux)
-#   
+#
 #   * add header
 #-

trunk/docs/docs_dev/makefile_non_sphinx

@@ -19 +19 @@
 # :ref:`Makefile`
 #
-# :ref:`extract_rst.sh`
+# :ref:`extract_rst.sh <fptools:extract_rst.sh>`
 #
 # :ref:`for_doc.sh`
@@ -207 +207 @@
 #
 #   * add man_troff which shell script possible now with docutils 0.6
-#     can be test with
-#      $ man -M ../doc/manuals/man varamma_profile.sh
+#     can be test with::
+#
+#      man -M ../doc/manuals/man varamma_profile.sh
 #
 # - fplod 2009-05-15T13:26:19Z aedon.locean-ipsl.upmc.fr (Darwin)
@@ -285 +286 @@
 $(shell echo "$(LIST_SRCMATLAB)" | \
         sed \
-            -e "s+../../utilitaires+source/manuals/utilitaires+g" \
+            -e "s+../../src/utilitaires+source/manuals/+g" \
             -e "s+../../src/+source/manuals/+g" \
             -e "s+\.m+.m.rst+g")
@@ -366 +367 @@
         @extract_rst.sh -i $< -l matlab -o $@
 
-source/manuals/utilitaires/%.m.rst : ../../src/utilitaires/%.m
+source/manuals/%.m.rst : ../../src/utilitaires/%.m
         @extract_rst.sh -i $< -l matlab -o $@
 

trunk/docs/docs_dev/source/conf.py

@@ -94 +94 @@
 # General information about the project.
 project = u'VARAMMA'
-copyright = u'2011,2012, CNRS'
+copyright = u'2008, 2009, 2010, 2011, 2012, CNRS'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -283 +283 @@
 
 # intersphinx with saxo
-intersphinx_mapping = {'saxo': ('http://forge.ipsl.jussieu.fr/saxo/download/idldoc_html_output/','saxo.inv')}
+intersphinx_mapping = {'saxo': ('http://forge.ipsl.jussieu.fr/saxo/download/idldoc_html_output/','saxo.inv'),
+                'fptools' : ('http://www.locean-ipsl.upmc.fr/~fplod/fptools/fptools_ws/doc/html/', None)}

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

@@ -43 +43 @@
 ~~~~~~~~~~~~~~~~~~~~~~~
 La documentation est construite à partir des fichiers ReStructuredText_ 
-dans :file:`${VARAMMA}/adm/` et des commentaires dans les sources 
-sous :file:`${VARAMMA}/src/`.
+dans :file:`${PROJECT}/adm/` et des commentaires dans les sources 
+sous :file:`${PROJECT}/src/`.
 
 .. _ReStructuredText: http://docutils.sourceforge.net/rst.html
@@ -57 +57 @@
  $ make clean
  $ make before
- $ make html_sphinx
+ $ make html_dev
 
 et regarder le résultat dans :file:`../doc/html/sphinx/index.html`.

trunk/docs/docs_dev/source/index_guides.rst

@@ -44 +44 @@
    guides/coding_rules
    guides/rundemotest
+   guides/builddoc
    guides/using
    guides/contributing
+   guides/svnbasiccommands
+   guides/contact