Changeset 668


Ignore:
Timestamp:
Jun 16, 2015, 4:33:55 PM (6 years ago)
Author:
nbozon
Message:

various fixes in docs

Location:
branches/PublicaMundi_David-devel/docs
Files:
1 added
4 edited

Legend:

Unmodified
Added
Removed
  • branches/PublicaMundi_David-devel/docs/conf.py

    r659 r668  
    11# -*- coding: utf-8 -*-
    22#
    3 # Sphinx documentation build configuration file
     3# ZOO Project documentation build configuration file
    44
    55import re
    66import sphinx
    77
    8 
    9 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
    10               'sphinx.ext.autosummary', 'sphinx.ext.extlinks',
    11               'sphinx.ext.viewcode']
    12 
     8extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo','sphinx.ext.autosummary', 'sphinx.ext.extlinks','sphinx.ext.viewcode']
    139master_doc = 'contents'
    1410templates_path = ['_templates']
    1511exclude_patterns = ['_build']
    1612
     13# General information
     14
    1715project = 'ZOO-Project'
    1816copyright = '2009-2015, ZOO-Project team'
    19 version = sphinx.__released__
    20 release = version
     17version = '1.0'
     18release = '1.5'
    2119show_authors = True
     20
     21# Options for HTML output
    2222
    2323html_theme = 'sphinx_rtd_theme'
     
    2828html_additional_pages = {'index': 'index.html'}
    2929html_use_opensearch = 'http://sphinx-doc.org'
    30 
    3130htmlhelp_basename = 'Sphinxdoc'
    3231
     32# Options for epub output
     33
    3334epub_theme = 'epub'
    34 epub_basename = 'sphinx'
    35 epub_author = 'Georg Brandl'
    36 epub_publisher = 'http://sphinx-doc.org/'
     35epub_basename = 'ZOO-Project'
     36epub_author = 'ZOO-Project team'
     37epub_publisher = 'http://zoo-project.org/'
    3738epub_scheme = 'url'
    38 epub_identifier = epub_publisher
    39 epub_pre_files = [('index.html', 'Welcome')]
    40 epub_post_files = [('install.html', 'Installing Sphinx'),
    41                    ('develop.html', 'Sphinx development')]
    42 epub_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']
     39epub_identifier = 'http://zoo-project.org'
     40epub_pre_files = [('index.html', 'ZOO-Project documentation')]
     41epub_post_files = [('install.html', 'Installing Sphinx'),('develop.html', 'Sphinx development')]
     42epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js','_static/jquery.js', '_static/searchtools.js','_static/underscore.js', '_static/basic.css','search.html', '_static/websupport.js']
    4643epub_fix_images = False
    4744epub_max_image_width = 0
     
    5047epub_guide = (('toc', 'contents.html', u'Table of Contents'),)
    5148
    52 latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation',
    53                     'Georg Brandl', 'manual', 1)]
    54 latex_logo = '_static/sphinx.png'
    55 latex_elements = {
    56     'fontpkg': '\\usepackage{palatino}',
    57 }
     49# Options for LaTeX output
     50
     51latex_documents = [('contents', 'ZOO-Project.tex', 'ZOO-Project Documentation','ZOO-Project team', 'manual', 1)]
     52latex_logo = '_static/zoo_simple.png'
     53latex_elements = {'fontpkg': '\\usepackage{palatino}'}
    5854latex_show_urls = 'footnote'
    59 
    60 autodoc_member_order = 'groupwise'
    6155todo_include_todos = True
    62 extlinks = {'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 
    69 man_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 
    80 texinfo_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:
    88 intersphinx_mapping = {'python': ('https://docs.python.org/2/', None)}
    89 
    90 # Sphinx document translation with sphinx gettext feature uses these settings:
    91 locale_dirs = ['locale/']
    92 gettext_compact = False
    93 
     56man_pages = [('index', 'zooproject', 'ZOO-Project Documentation','ZOO-Project team', 1)]
    9457
    9558# -- Extension interface -------------------------------------------------------
  • branches/PublicaMundi_David-devel/docs/contribute/code.rst

    r665 r668  
    2525* Create and commit to a new branch of the svn
    2626
    27 ZOO-Project registered developers must accept and respect the developer guidelines when contributing code.
     27ZOO-Project registered developers must accept and respect the :ref:developer guidelines when contributing code.
    2828
    2929Bug tracking
  • branches/PublicaMundi_David-devel/docs/contribute/contributors.rst

    r665 r668  
    2020   * Nicolas BOZON (aka nbozon)
    2121   * Trevor CLARKE (aka tclarke)
    22    * Luca DELUCCHI (aka lucadelu)   
     22   * Luca DELUCCHI (aka lucadelu)
     23   * René-Luc D'HONT  (aka reluc)
    2324   * Gérald FENOY (aka djay)
    2425   * Knut LANDMARK (aka knut)
     
    3233----------------
    3334
    34 The following individuals have also contributed to the ZOO-Project source code and documentation.
     35The following individuals have also contributed to the ZOO-Project
     36source code or documentation.
    3537
    36    * Thomas GRATTIER
    37    * René-Luc D'HONT
     38   * Thomas GRATIER
    3839   * Hirofumi HAYASHI
    3940   * Guillaume SUEUR
  • branches/PublicaMundi_David-devel/docs/contribute/index.rst

    r665 r668  
    44=============
    55
    6 This is the `ZOO-Project <http://zoo-project.org>`__ **Contributor Guide**. This document provides information and guidelines to anyone
    7 willing to contribute to the `ZOO-Project <http://zoo-project.org>`__
    8 open source software project and help making it better.
    9 
     6This is the `ZOO-Project <http://zoo-project.org>`__ **Contributor Guide**. This document provides information and guidelines to anyone willing to contribute to the `ZOO-Project <http://zoo-project.org>`__ open source software project and help making it better.
    107
    118.. toctree::
Note: See TracChangeset for help on using the changeset viewer.

Search

Context 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