Skip to content
Snippets Groups Projects
Select Git revision
  • master
1 result

index.php

Blame
  • Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    conf.py 8.25 KiB
    # -*- coding: utf-8 -*-
    #
    # openrave documentation build configuration file, created by
    # sphinx-quickstart on Mon Jul  5 12:45:31 2010.
    #
    # This file is execfile()d with the current directory set to its containing dir.
    #
    # Note that not all possible configuration values are present in this
    # autogenerated file.
    #
    # All configuration values have a default; values that are commented out
    # serve to show the default.
    
    import sys, os
    
    # If extensions (or modules to document with autodoc) are in another directory,
    # 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('sphinxext'))
    sys.path.append(os.path.abspath('openravepy'))
    
    # -- General configuration -----------------------------------------------------
    
    # 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.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig','sphinx.ext.todo','sphinx.ext.ifconfig','sphinx.ext.viewcode','sphinx.ext.autosummary','only_directives','gen_gallery','shellblock_directive','exampleblock_directive']
    
    # Add any paths that contain templates here, relative to this directory.
    templates_path = ['_templates']
    
    # The suffix of source filenames.
    source_suffix = '.rst'
    
    # The encoding of source files.
    source_encoding = 'utf-8'
    
    # The master toctree document.
    master_doc = 'contents'
    
    # General information about the project.
    project = u'OpenRAVE'
    copyright = u'2006-2012, Rosen Diankov and contributors'
    
    # The version info for the project you're documenting, acts as replacement for
    # |version| and |release|, also used in various other places throughout the
    # built documents.
    #
    # The short X.Y version.
    __builtins__['__openravepy_build_doc__'] = True
    import openravepy
    version = unicode(openravepy.__version__)
    # The full version, including alpha/beta/rc tags.
    #import pysvn
    #entry=pysvn.Client().info('..')
    #release = 'r%d'%entry.revision.number
    release = ''
    
    # relative to the source directory?
    locale_dirs = ['../locale']
    
    # The language for content autogenerated by Sphinx. Refer to documentation
    # for a list of supported languages.
    #language = 'en'
            
    # There are two options for replacing |today|: either, you set today to some
    # non-false value, then it is used:
    #today = ''
    # Else, today_fmt is used as the format for a strftime call.
    #today_fmt = '%B %d, %Y'
    
    # List of documents that shouldn't be included in the build.
    #unused_docs = []
    
    # exclude all svn cache
    exclude_patterns=['**/.svn']
    
    # The reST default role (used for this markup: `text`) to use for all documents.
    #default_role = None
    
    # If true, '()' will be appended to :func: etc. cross-reference text.
    #add_function_parentheses = True
    
    # If true, the current module name will be prepended to all description
    # unit titles (such as .. function::).
    add_module_names = True
    
    # If true, sectionauthor and moduleauthor directives will be shown in the
    # output. They are ignored by default.
    show_authors = True
    
    # The name of the Pygments (syntax highlighting) style to use.
    pygments_style = 'sphinx'#'trac' # sphinx
    
    # A list of ignored prefixes for module index sorting.
    modindex_common_prefix = ['openravepy.','openravepy.databases.','openravepy.examples.','openravepy.interfaces.']
    
    # for internationalization
    # docs: http://sphinx.pocoo.org/latest/intl.html
    # japanese tutorial: http://d.hatena.ne.jp/tk0miya/20111203
    needs_sphinx='1.1'
    
    autodoc_default_flags = ['members','show-inheritance','undoc-members']
    autoclass_content = 'both'
    
    # -- 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'.
    html_theme = 'sphinxdoc'
    #html_style='openrave_sphinx.css'
    
    # Theme options are theme-specific and customize the look and feel of a theme
    # further.  For a list of options available for each theme, see the
    # documentation.
    #html_theme_options = {}
    
    # Add any paths that contain custom themes here, relative to this directory.
    #html_theme_path = []
    
    # The name for this set of Sphinx documents.  If None, it defaults to
    # "<project> v<release> documentation".
    html_title = u'OpenRAVE ' + version
    
    # A shorter title for the navigation bar.  Default is the same as html_title.
    #html_short_title = None
    
    # The name of an image file (relative to this directory) to place at the top
    # of the sidebar.
    #html_logo = None
    
    # The name of an image file (within the static path) to use as favicon of the
    # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    # pixels large.
    favicon = 'openrave_icon_32.png'
    html_favicon = 'openrave_icon_32.png'
    
    # Add any paths that contain custom static files (such as style sheets) here,
    # relative to this directory. They are copied after the builtin static files,
    # so a file named "default.css" will overwrite the builtin "default.css".
    html_static_path = ['_static']
    
    # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    # using the given strftime format.
    #html_last_updated_fmt = '%b %d, %Y'
    
    # If true, SmartyPants will be used to convert quotes and dashes to
    # typographically correct entities.
    html_use_smartypants = True
    
    # HTML translator class for the builder
    #html_translator_class = "openravedocs.OpenRAVEHTMLTranslator"
    
    # Custom sidebar templates, maps document names to template names.
    html_sidebars = {'index':['localtoc.html','mailinglist.html','resources.html','sourcelink.html'],
                     '**':['localtoc.html','mailinglist.html','resources.html','sourcelink.html']}
    
    # Additional templates that should be rendered to pages, maps page names to
    # template names.
    html_additional_pages = {}#'databases':'databases.html' }#,'examples':'examples.html'}
    
    # If false, no module index is generated.
    #html_use_modindex = True
    
    # If false, no index is generated.
    #html_use_index = True
    
    # If true, the index is split into individual pages for each letter.
    #html_split_index = False
    
    # If true, links to the reST sources are added to the pages.
    #html_show_sourcelink = True
    
    # If true, an OpenSearch description file will be output, and all pages will
    # contain a <link> tag referring to it.  The value of this option must be the
    # base URL from which the finished HTML is served.
    #html_use_opensearch = ''
    
    # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
    #html_file_suffix = ''
    
    # Output file base name for HTML help builder.
    htmlhelp_basename = 'openravedoc'
    
    
    # -- Options for LaTeX output --------------------------------------------------
    
    # The paper size ('letter' or 'a4').
    #latex_paper_size = 'letter'
    
    # The font size ('10pt', '11pt' or '12pt').
    #latex_font_size = '10pt'
    
    # Grouping the document tree into LaTeX files. List of tuples
    # (source start file, target name, title, author, documentclass [howto/manual]).
    latex_documents = [
      ('openravepy', 'openrave.tex', u'OpenRAVE Documentation',
       u'author', 'manual'),
    ]
    
    # The name of an image file (relative to this directory) to place at the top of
    # the title page.
    #latex_logo = None
    
    # For "manual" documents, if this is true, then toplevel headings are parts,
    # not chapters.
    #latex_use_parts = False
    
    # Additional stuff for the LaTeX preamble.
    pngmath_latex_preamble = """
       \usepackage{amsmath}
       \usepackage{amsfonts}
       \usepackage{amssymb}
    """
    
    # Documents to append as an appendix to all manuals.
    #latex_appendices = []
    
    # If false, no module index is generated.
    #latex_use_modindex = True
    
    
    # Example configuration for intersphinx: refer to the Python standard library.
    intersphinx_mapping = {
        'python': ('http://docs.python.org/', None),
        'sphinx': ('http://sphinx.pocoo.org/', None),
        'numpy':('http://docs.scipy.org/doc/numpy',None),
    }
    
    # Python's docs don't change every week.
    intersphinx_cache_limit = 90 # days
    
    import gettext
    try:
        if 'SPHINXLANGUAGE' in os.environ:
            t = gettext.translation('openravesphinx','locale',languages=[os.environ['SPHINXLANGUAGE']])
        else:
            t = gettext.translation('openravesphinx','locale')
    except IOError:
        # no translation file found?
        t=gettext.NullTranslations()
        
    # added to the end of every file
    rst_epilog = u"""
    
    .. role:: red
    
    """