Changeset 659 for branches


Ignore:
Timestamp:
Jun 15, 2015, 6:41:01 PM (10 years ago)
Author:
nbozon
Message:

Massive update of zoo docs

Location:
branches/PublicaMundi_David-devel/docs
Files:
333 added
45 deleted
3 edited

Legend:

Unmodified
Added
Removed

  • branches/PublicaMundi_David-devel/docs/Makefile

    r348 r659  
    33
    44# You can set these variables from the command line.
    5 SPHINXOPTS    =
    6 SPHINXBUILD   = sphinx-build
    7 PAPER         =
    8 BUILDDIR      = _build
     5SPHINXOPTS   =
     6SPHINXBUILD  = python ../sphinx-build.py
     7SPHINXPROJ   = sphinx
     8SOURCEDIR    = .
     9BUILDDIR     = _build
    910
    10 # Internal variables.
    11 PAPEROPT_a4     = -D latex_paper_size=a4
    12 PAPEROPT_letter = -D latex_paper_size=letter
    13 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
     11# Has to be explicit, otherwise we don't get "make" without targets right.
     12help:
     13        @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
    1414
    15 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
    16 
    17 help:
    18         @echo "Please use \`make <target>' where <target> is one of"
    19         @echo "  html       to make standalone HTML files"
    20         @echo "  dirhtml    to make HTML files named index.html in directories"
    21         @echo "  singlehtml to make a single large HTML file"
    22         @echo "  pickle     to make pickle files"
    23         @echo "  json       to make JSON files"
    24         @echo "  htmlhelp   to make HTML files and a HTML help project"
    25         @echo "  qthelp     to make HTML files and a qthelp project"
    26         @echo "  devhelp    to make HTML files and a Devhelp project"
    27         @echo "  epub       to make an epub"
    28         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
    29         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
    30         @echo "  text       to make text files"
    31         @echo "  man        to make manual pages"
    32         @echo "  changes    to make an overview of all changed/added/deprecated items"
    33         @echo "  linkcheck  to check all external links for integrity"
    34         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
    35 
    36 clean:
    37         -rm -rf $(BUILDDIR)/*
    38 
    39 html:
    40         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
    41         @echo
    42         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
    43 
    44 dirhtml:
    45         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
    46         @echo
    47         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
    48 
    49 singlehtml:
    50         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
    51         @echo
    52         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
    53 
    54 pickle:
    55         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
    56         @echo
    57         @echo "Build finished; now you can process the pickle files."
    58 
    59 json:
    60         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
    61         @echo
    62         @echo "Build finished; now you can process the JSON files."
    63 
    64 htmlhelp:
    65         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
    66         @echo
    67         @echo "Build finished; now you can run HTML Help Workshop with the" \
    68               ".hhp project file in $(BUILDDIR)/htmlhelp."
    69 
    70 qthelp:
    71         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
    72         @echo
    73         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
    74               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
    75         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ZOOProject.qhcp"
    76         @echo "To view the help file:"
    77         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ZOOProject.qhc"
    78 
    79 devhelp:
    80         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
    81         @echo
    82         @echo "Build finished."
    83         @echo "To view the help file:"
    84         @echo "# mkdir -p $$HOME/.local/share/devhelp/ZOOProject"
    85         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ZOOProject"
    86         @echo "# devhelp"
    87 
    88 epub:
    89         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
    90         @echo
    91         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
    92 
    93 latex:
    94         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
    95         @echo
    96         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
    97         @echo "Run \`make' in that directory to run these through (pdf)latex" \
    98               "(use \`make latexpdf' here to do that automatically)."
    99 
    100 latexpdf:
    101         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
    102         @echo "Running LaTeX files through pdflatex..."
    103         make -C $(BUILDDIR)/latex all-pdf
    104         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
    105 
    106 text:
    107         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
    108         @echo
    109         @echo "Build finished. The text files are in $(BUILDDIR)/text."
    110 
    111 man:
    112         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
    113         @echo
    114         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
    115 
    116 changes:
    117         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
    118         @echo
    119         @echo "The overview file is in $(BUILDDIR)/changes."
    120 
    121 linkcheck:
    122         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
    123         @echo
    124         @echo "Link check complete; look for any errors in the above output " \
    125               "or in $(BUILDDIR)/linkcheck/output.txt."
    126 
    127 doctest:
    128         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
    129         @echo "Testing of doctests in the sources finished, look at the " \
    130               "results in $(BUILDDIR)/doctest/output.txt."
     15# Catch-all target: route all unknown targets to Sphinx using the new
     16# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
     17%:
     18        @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

  • branches/PublicaMundi_David-devel/docs/_templates/indexsidebar.html

    r456 r659  
    1 <div class="categories">
    2   <a href="/site/Downloads"><h1>Download now !</h1>
    3         <p class="version">ZOO Version 1.3.0</p></a>
    4 </div>
    5 <div class="donate">
    6   <h1 id="SupportZOO-Project">Support ZOO-Project</h1>
    7     <form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="text-align: center;">
    8       <input type="hidden" name="cmd" value="_s-xclick"></input>
    9       <input type="hidden" name="hosted_button_id" value="WTHKTUQBHBHSQ"></input>
    10       <input type="image" src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!" style="border:0"></input>
    11       <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1"></img>
    12     </form>
    13 </div>
    14 <div class="twitts">
    15   <h1 id="FollowtheZOO">Follow the ZOO</h1>
    16     <p>
    17       <a style="padding:0; border:none" href="http://twitter.com/ZOO_Project"><img src="http://a0.twimg.com/a/1291253242/images/fronts/logo_withbird_home.png" alt="http://a0.twimg.com/a/1291253242/images/fronts/logo_withbird_home.png" title="http://a0.twimg.com/a/1291253242/images/fronts/logo_withbird_home.png"></img></a>
    18     </p>
    19 </div>
     1<p class="logo">A <a href="http://pocoo.org/">
     2  <img src="{{ pathto("_static/pocoo.png", 1) }}" alt="Pocoo" /></a>
     3  {%trans%}project{%endtrans%}</p>
    204
     5<h3>Download</h3>
     6{% if version.endswith('a0') %}
     7<p>{%trans%}This documentation is for version <b>{{ version }}</b>, which is
     8  not released yet.{%endtrans%}</p>
     9<p>{%trans%}You can use it from the
     10  <a href="https://github.com/sphinx-doc/sphinx/">Git repo</a> or look for
     11  released versions in the <a href="https://pypi.python.org/pypi/Sphinx">Python
     12    Package Index</a>.{%endtrans%}</p>
     13{% else %}
     14<p>{%trans%}Current version: <b>{{ version }}</b>{%endtrans%}</p>
     15<p>{%trans%}Get Sphinx from the <a href="https://pypi.python.org/pypi/Sphinx">Python Package
     16Index</a>, or install it with:{%endtrans%}</p>
     17{% if version.split('b')|length > 1 %}
     18<pre>pip install Sphinx=={{ version }}</pre>
     19<p>{%trans%}<a href="http://sphinx-doc.org/">Stable version docs</a>
     20are also available.{%endtrans%}</p>
     21{% else %}
     22<pre>pip install -U Sphinx</pre>
     23<p>{%trans%}Latest <a href="http://sphinx-doc.org/latest/">development version docs</a>
     24are also available.{%endtrans%}</p>
     25{% endif %}
     26{% endif %}
     27
     28<h3>{%trans%}Questions? Suggestions?{%endtrans%}</h3>
     29
     30<p>{%trans%}Join the <a href="http://groups.google.com/group/sphinx-users">Google group</a>:{%endtrans%}</p>
     31<form action="http://groups.google.com/group/sphinx-users/boxsubscribe"
     32      style="padding-left: 0.5em">
     33  <input type="text" name="email" value="your@email" style="font-size: 90%; width: 120px"
     34         onfocus="$(this).val('');"/>
     35  <input type="submit" name="sub" value="Subscribe" style="font-size: 90%; width: 70px"/>
     36</form>
     37<p>{%trans%}or come to the <tt>#sphinx-doc</tt> channel on FreeNode.{%endtrans%}</p>
     38<p>{%trans%}You can also open an issue at the
     39  <a href="https://github.com/sphinx-doc/sphinx/issues">tracker</a>.{%endtrans%}</p>

  • branches/PublicaMundi_David-devel/docs/conf.py

    r416 r659  
    11# -*- coding: utf-8 -*-
    22#
    3 # ZOO Project documentation build configuration file, created by
    4 # sphinx-quickstart on Tue Mar 08 12:11:20 2011.
    5 #
    6 # This file is execfile()d with the current directory set to its containing dir.
    7 #
    8 # Note that not all possible configuration values are present in this
    9 # autogenerated file.
    10 #
    11 # All configuration values have a default; values that are commented out
    12 # serve to show the default.
     3# Sphinx documentation build configuration file
    134
    14 import sys, os
     5import re
     6import sphinx
    157
    16 # If extensions (or modules to document with autodoc) are in another directory,
    17 # add these directories to sys.path here. If the directory is relative to the
    18 # documentation root, use os.path.abspath to make it absolute, like shown here.
    19 #sys.path.insert(0, os.path.abspath('.'))
    208
    21 # -- General configuration -----------------------------------------------------
     9extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
     10              'sphinx.ext.autosummary', 'sphinx.ext.extlinks',
     11              'sphinx.ext.viewcode']
    2212
    23 # If your documentation needs a minimal Sphinx version, state it here.
    24 #needs_sphinx = '1.0'
    25 
    26 # Add any Sphinx extension module names here, as strings. They can be extensions
    27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
    28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
    29 
    30 # Add any paths that contain templates here, relative to this directory.
     13master_doc = 'contents'
    3114templates_path = ['_templates']
    32 
    33 # The suffix of source filenames.
    34 source_suffix = '.txt'
    35 
    36 # The encoding of source files.
    37 #source_encoding = 'utf-8-sig'
    38 
    39 # The master toctree document.
    40 master_doc = 'index'
    41 
    42 # General information about the project.
    43 project = u'ZOO Project'
    44 copyright = u'2011, Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
    45 
    46 # The version info for the project you're documenting, acts as replacement for
    47 # |version| and |release|, also used in various other places throughout the
    48 # built documents.
    49 #
    50 # The short X.Y version.
    51 version = '1.0'
    52 # The full version, including alpha/beta/rc tags.
    53 release = '1.3'
    54 
    55 # The language for content autogenerated by Sphinx. Refer to documentation
    56 # for a list of supported languages.
    57 #language = None
    58 
    59 # There are two options for replacing |today|: either, you set today to some
    60 # non-false value, then it is used:
    61 #today = ''
    62 # Else, today_fmt is used as the format for a strftime call.
    63 #today_fmt = '%B %d, %Y'
    64 
    65 # List of patterns, relative to source directory, that match files and
    66 # directories to ignore when looking for source files.
    6715exclude_patterns = ['_build']
    6816
    69 # The reST default role (used for this markup: `text`) to use for all documents.
    70 #default_role = None
     17project = 'ZOO-Project'
     18copyright = '2009-2015, ZOO-Project team'
     19version = sphinx.__released__
     20release = version
     21show_authors = True
    7122
    72 # If true, '()' will be appended to :func: etc. cross-reference text.
    73 #add_function_parentheses = True
     23html_theme = 'sphinx_rtd_theme'
     24html_theme_path = ['_themes']
     25modindex_common_prefix = ['sphinx.']
     26html_static_path = ['_static']
     27html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
     28html_additional_pages = {'index': 'index.html'}
     29html_use_opensearch = 'http://sphinx-doc.org'
    7430
    75 # If true, the current module name will be prepended to all description
    76 # unit titles (such as .. function::).
    77 #add_module_names = True
     31htmlhelp_basename = 'Sphinxdoc'
    7832
    79 # If true, sectionauthor and moduleauthor directives will be shown in the
    80 # output. They are ignored by default.
    81 #show_authors = False
     33epub_theme = 'epub'
     34epub_basename = 'sphinx'
     35epub_author = 'Georg Brandl'
     36epub_publisher = 'http://sphinx-doc.org/'
     37epub_scheme = 'url'
     38epub_identifier = epub_publisher
     39epub_pre_files = [('index.html', 'Welcome')]
     40epub_post_files = [('install.html', 'Installing Sphinx'),
     41                   ('develop.html', 'Sphinx development')]
     42epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
     43                      '_static/jquery.js', '_static/searchtools.js',
     44                      '_static/underscore.js', '_static/basic.css',
     45                      'search.html', '_static/websupport.js']
     46epub_fix_images = False
     47epub_max_image_width = 0
     48epub_show_urls = 'inline'
     49epub_use_index = False
     50epub_guide = (('toc', 'contents.html', u'Table of Contents'),)
    8251
    83 # The name of the Pygments (syntax highlighting) style to use.
    84 pygments_style = 'sphinx'
     52latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation',
     53                    'Georg Brandl', 'manual', 1)]
     54latex_logo = '_static/sphinx.png'
     55latex_elements = {
     56    'fontpkg': '\\usepackage{palatino}',
     57}
     58latex_show_urls = 'footnote'
    8559
    86 # A list of ignored prefixes for module index sorting.
    87 #modindex_common_prefix = []
     60autodoc_member_order = 'groupwise'
     61todo_include_todos = True
     62extlinks = {'duref': ('http://docutils.sourceforge.net/docs/ref/rst/'
     63                      'restructuredtext.html#%s', ''),
     64            'durole': ('http://docutils.sourceforge.net/docs/ref/rst/'
     65                       'roles.html#%s', ''),
     66            'dudir': ('http://docutils.sourceforge.net/docs/ref/rst/'
     67                      'directives.html#%s', '')}
     68
     69man_pages = [
     70    ('contents', 'sphinx-all', 'Sphinx documentation generator system manual',
     71     'Georg Brandl', 1),
     72    ('man/sphinx-build', 'sphinx-build', 'Sphinx documentation generator tool',
     73     '', 1),
     74    ('man/sphinx-quickstart', 'sphinx-quickstart', 'Sphinx documentation '
     75     'template generator', '', 1),
     76    ('man/sphinx-apidoc', 'sphinx-apidoc', 'Sphinx API doc generator tool',
     77     '', 1),
     78]
     79
     80texinfo_documents = [
     81    ('contents', 'sphinx', 'Sphinx Documentation', 'Georg Brandl',
     82     'Sphinx', 'The Sphinx documentation builder.', 'Documentation tools',
     83     1),
     84]
     85
     86# We're not using intersphinx right now, but if we did, this would be part of
     87# the mapping:
     88intersphinx_mapping = {'python': ('https://docs.python.org/2/', None)}
     89
     90# Sphinx document translation with sphinx gettext feature uses these settings:
     91locale_dirs = ['locale/']
     92gettext_compact = False
    8893
    8994
    90 # -- Options for HTML output ---------------------------------------------------
     95# -- Extension interface -------------------------------------------------------
    9196
    92 # The theme to use for HTML and HTML Help pages.  See the documentation for
    93 # a list of builtin themes.
    94 html_theme = 'default'
     97from sphinx import addnodes  # noqa
    9598
    96 # Theme options are theme-specific and customize the look and feel of a theme
    97 # further.  For a list of options available for each theme, see the
    98 # documentation.
    99 html_theme_options = {
    100     "rightsidebar": "true",
    101     "headbgcolor": "#ffffff",
    102     "bgcolor": "#ffffff",
    103     "textcolor": "#333333",
    104     "linkcolor": "#fc9326",
    105     "visitedlinkcolor": "#fc9326",   
    106     "sidebarbgcolor": "white",
    107     "relbarbgcolor": "#ffa500"   
    108 }
    109 
    110 # Add any paths that contain custom themes here, relative to this directory.
    111 #html_theme_path = []
    112 
    113 # The name for this set of Sphinx documents.  If None, it defaults to
    114 # "<project> v<release> documentation".
    115 html_title = "ZOO Project " + release + " documentation"
    116 
    117 # A shorter title for the navigation bar.  Default is the same as html_title.
    118 html_short_title = "ZOO Docs"
    119 
    120 # The name of an image file (relative to this directory) to place at the top
    121 # of the sidebar.
    122 #html_logo =
    123 
    124 # The name of an image file (within the static path) to use as favicon of the
    125 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    126 # pixels large.
    127 html_favicon = "favicon.ico"
    128 
    129 # Add any paths that contain custom static files (such as style sheets) here,
    130 # relative to this directory. They are copied after the builtin static files,
    131 # so a file named "default.css" will overwrite the builtin "default.css".
    132 html_static_path = ['_static']
    133 
    134 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    135 # using the given strftime format.
    136 #html_last_updated_fmt = '%b %d, %Y'
    137 
    138 # If true, SmartyPants will be used to convert quotes and dashes to
    139 # typographically correct entities.
    140 #html_use_smartypants = True
    141 
    142 # Custom sidebar templates, maps document names to template names.
    143 html_sidebars = {
    144 '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
    145 "index":["indexsidebar.html",'searchbox.html']}
    146 
    147 # Additional templates that should be rendered to pages, maps page names to
    148 # template names.
    149 #html_additional_pages = {}
    150 
    151 # If false, no module index is generated.
    152 #html_domain_indices = True
    153 
    154 # If false, no index is generated.
    155 #html_use_index = True
    156 
    157 # If true, the index is split into individual pages for each letter.
    158 #html_split_index = False
    159 
    160 # If true, links to the reST sources are added to the pages.
    161 html_show_sourcelink = False
    162 
    163 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
    164 html_show_sphinx = False
    165 
    166 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
    167 html_show_copyright = False
    168 
    169 # If true, an OpenSearch description file will be output, and all pages will
    170 # contain a <link> tag referring to it.  The value of this option must be the
    171 # base URL from which the finished HTML is served.
    172 #html_use_opensearch = ''
    173 
    174 # This is the file name suffix for HTML files (e.g. ".xhtml").
    175 #html_file_suffix = None
    176 
    177 # Output file base name for HTML help builder.
    178 htmlhelp_basename = 'ZOOProjectdoc'
     99event_sig_re = re.compile(r'([a-zA-Z-]+)\s*\((.*)\)')
    179100
    180101
    181 # -- Options for LaTeX output --------------------------------------------------
    182 
    183 # The paper size ('letter' or 'a4').
    184 #latex_paper_size = 'letter'
    185 
    186 # The font size ('10pt', '11pt' or '12pt').
    187 #latex_font_size = '10pt'
    188 
    189 # Grouping the document tree into LaTeX files. List of tuples
    190 # (source start file, target name, title, author, documentclass [howto/manual]).
    191 latex_documents = [
    192   ('index', 'ZOOProject.tex', u'ZOO Project Documentation',
    193    u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna', 'manual'),
    194 ]
    195 
    196 # The name of an image file (relative to this directory) to place at the top of
    197 # the title page.
    198 latex_logo = './_static/images/zoo-banner-large.png'
    199 
    200 # For "manual" documents, if this is true, then toplevel headings are parts,
    201 # not chapters.
    202 #latex_use_parts = False
    203 
    204 # If true, show page references after internal links.
    205 #latex_show_pagerefs = False
    206 
    207 # If true, show URL addresses after external links.
    208 #latex_show_urls = False
    209 
    210 # Additional stuff for the LaTeX preamble.
    211 latex_preamble = '\setcounter{tocdepth}{3}'
    212 
    213 # Documents to append as an appendix to all manuals.
    214 #latex_appendices = []
    215 
    216 # If false, no module index is generated.
    217 #latex_domain_indices = True
     102def parse_event(env, sig, signode):
     103    m = event_sig_re.match(sig)
     104    if not m:
     105        signode += addnodes.desc_name(sig, sig)
     106        return sig
     107    name, args = m.groups()
     108    signode += addnodes.desc_name(name, name)
     109    plist = addnodes.desc_parameterlist()
     110    for arg in args.split(','):
     111        arg = arg.strip()
     112        plist += addnodes.desc_parameter(arg, arg)
     113    signode += plist
     114    return name
    218115
    219116
    220 # -- Options for manual page output --------------------------------------------
    221 
    222 # One entry per manual page. List of tuples
    223 # (source start file, name, description, authors, manual section).
    224 man_pages = [
    225     ('index', 'zooproject', u'ZOO Project Documentation',
    226      [u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna'], 1)
    227 ]
    228 
    229 
    230 # -- Options for Epub output ---------------------------------------------------
    231 
    232 # Bibliographic Dublin Core info.
    233 epub_title = u'ZOO Project'
    234 epub_author = u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
    235 epub_publisher = u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
    236 epub_copyright = u'2011, Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
    237 
    238 # The language of the text. It defaults to the language option
    239 # or en if the language is not set.
    240 #epub_language = ''
    241 
    242 # The scheme of the identifier. Typical schemes are ISBN or URL.
    243 epub_scheme = 'URL'
    244 
    245 # The unique identifier of the text. This can be a ISBN number
    246 # or the project homepage.
    247 epub_identifier = 'http://zoo-project.org'
    248 
    249 # A unique identification for the text.
    250 #epub_uid = ''
    251 
    252 # HTML files that should be inserted before the pages created by sphinx.
    253 # The format is a list of tuples containing the path and title.
    254 #epub_pre_files = []
    255 
    256 # HTML files shat should be inserted after the pages created by sphinx.
    257 # The format is a list of tuples containing the path and title.
    258 #epub_post_files = []
    259 
    260 # A list of files that should not be packed into the epub file.
    261 #epub_exclude_files = []
    262 
    263 # The depth of the table of contents in toc.ncx.
    264 #epub_tocdepth = 3
    265 
    266 # Allow duplicate toc entries.
    267 #epub_tocdup = True
     117def setup(app):
     118    from sphinx.ext.autodoc import cut_lines
     119    from sphinx.util.docfields import GroupedField
     120    app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
     121    app.add_object_type('confval', 'confval',
     122                        objname='configuration value',
     123                        indextemplate='pair: %s; configuration value')
     124    fdesc = GroupedField('parameter', label='Parameters',
     125                         names=['param'], can_collapse=True)
     126    app.add_object_type('event', 'event', 'pair: %s; event', parse_event,
     127                        doc_field_types=[fdesc])
Note: See TracChangeset for help on using the changeset viewer.

Download now !

Search

Context Navigation

Main Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png