Changeset 518 for trunk/docs

Timestamp:

04/13/12 15:05:27 (12 years ago)

Author:

pinsard

Message:

consolidation of doc dev.

Location:

trunk/docs/docs_dev

Files:

• Makefile (modified) (7 diffs)
• makefile_non_sphinx (modified) (1 diff)
• source/conf.py (modified) (1 diff)
• source/index.rst (modified) (1 diff)

trunk/docs/docs_dev/Makefile

@@ -25 +25 @@
 # logo
 #
-# update whith new sphinx backend
 #
 # EVOLUTIONS
@@ -33 +32 @@
 #
 # $URL: svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/fptools/svn/trunk/docs/docs_dev/Makefile $
+#
+# - fplod 20120413
+#
+#   * update whith new sphinx backend
 #
 # - fplod 20120413T082638Z cratos (Linux)
@@ -44 +47 @@
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = ../../doc/
 
 # Internal variables.
@@ -51 +54 @@
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
 help:
         @echo "Please use \`make <target>' where <target> is one of"
-        @echo "  html      to make standalone HTML files"
-        @echo "  dirhtml   to make HTML files named index.html in directories"
-        @echo "  pickle    to make pickle files"
-        @echo "  json      to make JSON files"
-        @echo "  htmlhelp  to make HTML files and a HTML help project"
-        @echo "  qthelp    to make HTML files and a qthelp project"
-        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-        @echo "  changes   to make an overview of all changed/added/deprecated items"
-        @echo "  linkcheck to check all external links for integrity"
-        @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
+        @echo "Please use \`make <target>' where <target> is one of"
+        @echo "  html       to make standalone HTML files"
+        @echo "  dirhtml    to make HTML files named index.html in directories"
+        @echo "  singlehtml to make a single large HTML file"
+        @echo "  pickle     to make pickle files"
+        @echo "  json       to make JSON files"
+        @echo "  htmlhelp   to make HTML files and a HTML help project"
+        @echo "  qthelp     to make HTML files and a qthelp project"
+        @echo "  devhelp    to make HTML files and a Devhelp project"
+        @echo "  epub       to make an epub"
+        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+        @echo "  text       to make text files"
+        @echo "  man        to make manual pages"
+        @echo "  changes    to make an overview of all changed/added/deprecated items"
+        @echo "  linkcheck  to check all external links for integrity"
+        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
 clean:
@@ -81 +91 @@
         @echo
         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+        @make -f makefile_non_sphinx all
+        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+        @echo
+        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
 pickle:
@@ -110 +126 @@
         @echo "To view the help file:"
         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/VARAMMA.qhc"
+devhelp:
+        @make -f makefile_non_sphinx all
+        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+        @echo
+        @echo "Build finished."
+        @echo "To view the help file:"
+        @echo "# mkdir -p $$HOME/.local/share/devhelp/TROPFLUX"
+        @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TROPFLUX"
+        @echo "# devhelp"
+
+epub:
+        @make -f makefile_non_sphinx all
+        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+        @echo
+        @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 
 latex:
@@ -118 +149 @@
         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
               "run these through (pdf)latex."
+
+latexpdf:
+        @make -f makefile_non_sphinx all
+        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+        @echo "Running LaTeX files through pdflatex..."
+        make -C $(BUILDDIR)/latex all-pdf
+        @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+        @make -f makefile_non_sphinx all
+        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+        @echo
+        @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+        @make -f makefile_non_sphinx all
+        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+        @echo
+        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
 changes:

trunk/docs/docs_dev/makefile_non_sphinx

@@ -291 +291 @@
 
 LIST_SRCFERRET = \
-$(shell find $(DIRSRC) -name "*.jnl" | sort)
+$(shell find ../.. ! \( -name '.svn' -prune \) -name "*.jnl" | sort)
 
 LIST_SRCFERRET_RST = \

trunk/docs/docs_dev/source/conf.py

@@ -233 +233 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'VARAMMA.tex', u'VARAMMA Documentation',
+  ('index', 'varamma_dev.tex', u'VARAMMA developpers documentation',
    u'CNRS', 'manual'),
 ]

trunk/docs/docs_dev/source/index.rst

@@ -25 +25 @@
 .. only:: html
 
-   **Download** offline version (`.pdf <../../pdf/sphinx/VARAMMA.pdf>`__)
+   **Download** offline version (`.pdf <../latex/varamma_dev.pdf>`__)
 
 .. toctree::