From 8148ad42592aede318905f70b7aa821d49f4316b Mon Sep 17 00:00:00 2001 From: florent <florent@laas.fr> Date: Tue, 23 Nov 2010 21:01:03 +0100 Subject: [PATCH] Use autotools substitution rule. * cmake: synchronize, * doc/CMakeLists.txt: synchronize, * doc/sphinx/conf.py.in: new, * doc/sphinx/index.rst.in: new. --- cmake | 2 +- doc/CMakeLists.txt | 4 +- doc/sphinx/conf.py.in | 199 ++++++++++++++++++++++++++++++++++++++++ doc/sphinx/index.rst.in | 42 +++++++++ 4 files changed, 244 insertions(+), 3 deletions(-) create mode 100644 doc/sphinx/conf.py.in create mode 100644 doc/sphinx/index.rst.in diff --git a/cmake b/cmake index 412ecd1..d37b747 160000 --- a/cmake +++ b/cmake @@ -1 +1 @@ -Subproject commit 412ecd11e73be9f421b0f832a4c0d3124af2956e +Subproject commit d37b7471cc1cb599ccffbb426150b4e40a3d71ff diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index b3afbcb..ad1b47c 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -5,5 +5,5 @@ INCLUDE(../cmake/sphinx.cmake) -SPHINX_SETUP_PROJECT_DOCUMENTATION() -SPHINX_SETUP_PROJECT_DOCUMENTATION_FINALIZE() +SPHINX_SETUP() +SPHINX_FINALIZE() diff --git a/doc/sphinx/conf.py.in b/doc/sphinx/conf.py.in new file mode 100644 index 0000000..cdabf7e --- /dev/null +++ b/doc/sphinx/conf.py.in @@ -0,0 +1,199 @@ +# -*- coding: utf-8 -*- +# +# @PROJECT_NAME@ documentation build configuration file, created by +# sphinx-quickstart on Mon Nov 22 16:45:27 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 = [os.path.abspath('@CMAKE_BINARY_DIR@/src')]+sys.path +sys.path = [os.path.abspath('@CMAKE_SOURCE_DIR@/src')]+sys.path + +# -- 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'] + +# 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 = 'index' + +# General information about the project. +project = u'@PROJECT_NAME@' +copyright = u'2010, Florent Lamiraux' + +# 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. +version = '1.0' +# The full version, including alpha/beta/rc tags. +release = '1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# 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 = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +exclude_trees = [] + +# 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 = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#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'. +html_theme = 'default' + +# 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 = None + +# 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. +#html_favicon = None + +# 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 + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# 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 = '@PROJECT_NAME@doc' + + +# -- 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 = [ + ('index', '@PROJECT_NAME@.tex', u'@PROJECT_NAME@ Documentation', + u'Florent Lamiraux', '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. +#latex_preamble = '' + +# 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 = {'http://docs.python.org/': None} diff --git a/doc/sphinx/index.rst.in b/doc/sphinx/index.rst.in new file mode 100644 index 0000000..9a49507 --- /dev/null +++ b/doc/sphinx/index.rst.in @@ -0,0 +1,42 @@ +.. dynamic-graph-python documentation master file, created by + sphinx-quickstart on Mon Nov 22 16:45:27 2010. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to dynamic-graph-python's documentation! +================================================ + +.. toctree:: + :maxdepth: 2 + +Python module dynamic_graph implements bindings for dynamic-graph_ library. To each main C++ class is associated a Python class. Main classes are listed below. + +Entity +------ +maps dynamicgraph::Entity_ C++ class. + +.. autoclass:: dynamic_graph.entity.Entity + :members: + +SignalBase +---------- +maps dynamicgraph::SignalBase_ C++ class. + +.. autoclass:: dynamic_graph.signal_base.SignalBase + :members: + +Other funtions of the module +---------------------------- +.. automodule:: dynamic_graph + :members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +.. _dynamic-graph: file://@DYNAMIC_GRAPH_DOXYGENDOCDIR@/index.html +.. _Entity: file://@DYNAMIC_GRAPH_DOXYGENDOCDIR@/classdynamicgraph_1_1_entity.html +.. _SignalBase: file://@DYNAMIC_GRAPH_DOXYGENDOCDIR@/classdynamicgraph_1_1_signal_base.html -- GitLab