Changeset 628 for trunk/docs

Timestamp:

07/31/13 17:18:54 (11 years ago)

Author:

pinsard

Message:

add apidoc for python documentation generation, improve links

Location:

trunk/docs/docs_dev

Files:

• Makefile (modified) (5 diffs)
• source/guides/rundemotest.rst (modified) (1 diff)
• source/manuals/manuals_python.rst (deleted)

trunk/docs/docs_dev/Makefile

@@ -32 +32 @@
 #
 # $URL: svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/fptools/svn/trunk/docs/docs_dev/Makefile $
+#
+# - fplod 20130731T144015Z cratos.locean-ipsl.upmc.fr (Linux)
+#
+#   * add apidoc
 #
 # - fplod 20120413
@@ -78 +82 @@
 clean:
         @make -f makefile_non_sphinx clean
+        -rm -rf source/manuals/src/
         -rm -rf $(BUILDDIR)/*
 
-html:
+apidoc :
+        sphinx-apidoc -f -H "varamma scripts" -o source/manuals/src/ ../../src/
+
+html: \
+apidoc
         @make -f makefile_non_sphinx all
         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -150 +159 @@
               "run these through (pdf)latex."
 
-latexpdf:
+latexpdf: \
+apidoc
         @make -f makefile_non_sphinx all
         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@@ -175 +185 @@
         @echo "The overview file is in $(BUILDDIR)/changes."
 
-linkcheck:
+linkcheck: \
+apidoc
         @make -f makefile_non_sphinx all
         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@@ -182 +193 @@
               "or in $(BUILDDIR)/linkcheck/output.txt."
 
-doctest:
+doctest: 
         @make -f makefile_non_sphinx all
         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

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

@@ -59 +59 @@
 ~~~~~~
 
-All demos can be launched wtih one octave command::
+All demos can be launched with one octave command::
 
  $ cd ${PROJECT}/src