Changeset 143 for trunk/docs

Timestamp:

02/27/12 13:47:56 (12 years ago)

Author:

pinsard

Message:

cleanning dev. doc again

Location:

trunk/docs/docs_dev

Files:

• Makefile (modified) (5 diffs)
• source/_static (added)
• source/_templates (added)
• source/conf.py (modified) (15 diffs)
• source/index.rst (added)

trunk/docs/docs_dev/Makefile

@@ -3 +3 @@
 
 # You can set these variables from the command line.
-SPHINXOPTS    = 
+SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
@@ -11 +11 @@
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 
+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 "  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:
@@ -40 +46 @@
         @echo
         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+        @echo
+        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
 pickle:
@@ -62 +73 @@
         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/superbib.qhcp"
+        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SUPERBIB.qhcp"
         @echo "To view the help file:"
-        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/superbib.qhc"
+        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SUPERBIB.qhc"
+
+devhelp:
+        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+        @echo
+        @echo "Build finished."
+        @echo "To view the help file:"
+        @echo "# mkdir -p $$HOME/.local/share/devhelp/SUPERBIB"
+        @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SUPERBIB"
+        @echo "# devhelp"
+
+epub:
+        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+        @echo
+        @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 
 latex:
@@ -70 +95 @@
         @echo
         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-              "run these through (pdf)latex."
+        @echo "Run \`make' in that directory to run these through (pdf)latex" \
+              "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+        $(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:
+        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+        @echo
+        @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+        @echo
+        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
 changes:

trunk/docs/docs_dev/source/conf.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 #
-# superbib documentation build configuration file, created by
-# sphinx-quickstart on Wed Mar 10 16:19:33 2010.
+# SUPERBIB documentation build configuration file, created by
+# sphinx-quickstart on Mon Feb 27 13:21:08 2012.
 #
 # This file is execfile()d with the current directory set to its containing dir.
@@ -11 +11 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-#
-#+
-#
-# TODO
-# ====
-#
-# - fplod 20100621T075245Z aedon.locean-ipsl.upmc.fr (Darwin)
-#
-#   * use a specific index.rst for man troff
-#   * find a way to avoird hard coded man pages name here (should be in
-#     adm/makefile)
-#
-# EVOLUTIONS
-# ==========
-#
-# $Id$
-#
-#   * produce man page for almost all shell scripts
-#
-#-
 
 import sys, os
@@ -37 +17 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath('/usr/home/fplod/src/superbib_ws/adm/sphinx_tmpdir/source/'))
-
+#sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.todo']
-todo_include_todos = True
-
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -55 +35 @@
 
 # The encoding of source files.
-source_encoding = 'iso-8859-15'
+#source_encoding = 'utf-8-sig'
 
 # The master toctree document.
@@ -61 +41 @@
 
 # General information about the project.
-project = u'superbib'
-copyright = u'2010, CNRS'
+project = u'SUPERBIB'
+copyright = u'2012, fp'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -69 +49 @@
 #
 # The short X.Y version.
-version = '1.0.0'
+version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.0'
+release = '2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-language = 'en'
+#language = None
 
 # There are two options for replacing |today|: either, you set today to some
@@ -82 +62 @@
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
-today_fmt = '%Y%m%d'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = []
-
-exclude_dirnames = ['.svn']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
 
 # The reST default role (used for this markup: `text`) to use for all documents.
@@ -111 +85 @@
 
 # A list of ignored prefixes for module index sorting.
-modindex_common_prefix = []
+#modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
 html_theme = 'default'
 
@@ -162 +136 @@
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-html_additional_pages = {'index': 'index.html'}
+#html_additional_pages = {}
 
 # If false, no module index is generated.
-html_use_modindex = True
+#html_domain_indices = True
 
 # If false, no index is generated.
-html_use_index = True
+#html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
@@ -174 +148 @@
 
 # If true, links to the reST sources are added to the pages.
-html_show_sourcelink = False
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
@@ -181 +161 @@
 #html_use_opensearch = ''
 
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'superbib_tools'
+htmlhelp_basename = 'SUPERBIBdoc'
 
 
@@ -199 +179 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'superbib.tex', u'Superbib tools Documentation',
-   u'Francoise Pinsard', 'manual'),
+  ('index', 'SUPERBIB.tex', u'SUPERBIB Documentation',
+   u'fp', 'manual'),
 ]
 
@@ -211 +191 @@
 #latex_use_parts = False
 
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
@@ -218 +204 @@
 
 # If false, no module index is generated.
-#latex_use_modindex = True
-
-keep_warnings = 'True'
+#latex_domain_indices = True
+
+
 # -- Options for manual page output --------------------------------------------
 
@@ -226 +212 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'SUPERBIB', u'SUPERBIB Documentation', [u'fp'], 1),
-    ('before.sh', 'before.sh', u'before.sh Documentation', [u'fp'], 1),
-    ('bibopa.sh', 'bibopa.sh', u'bibopa.sh Documentation', [u'fp'], 1),
-    ('install.sh', 'install.sh', u'install.sh Documentation', [u'fp'], 1),
-    ('linkchecker.sh', 'linkchecker.sh', u'linkchecker.sh Documentation', [u'fp'], 1),
-    ('mailtouser.sh', 'mailtouser.sh', u'mailtouser.sh Documentation', [u'fp'], 1),
-    ('superbib_profile.sh', 'superbib_profile.sh', u'superbib_profile.sh Documentation', [u'fp'], 1),
-    ('twindoi.sh', 'twindoi.sh', u'twindoi.sh Documentation', [u'fp'], 1)
+    ('index', 'superbib', u'SUPERBIB Documentation',
+     [u'fp'], 1)
 ]
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'SUPERBIB'
+epub_author = u'fp'
+epub_publisher = u'fp'
+epub_copyright = u'2012, fp'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}