Commit d934670b authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Add the logic to generated the API documentation.

parent ab5cc1f4
Callbacks
---------
Functions
^^^^^^^^^
.. currentmodule:: callbacks
.. autosummary::
:toctree: generated/
~INHIBIT_CASCADE_DELETE
# -*- coding: utf-8 -*-
#
# track_event api documentation build configuration file, created by
# sphinx-quickstart on Sat Apr 11 11:17:03 2015.
#
# 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 os
import re
import sys
from datetime import datetime
def get_version():
"""Get the current version identifier.
Returns:
str: the version number
"""
log = open('../../static/CHANGELOG').read()
match = re.search(r"(\d+\.\d+(\.\d+)*)", log)
if match:
return match.group(1)
return ""
# 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.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../../modules'))
sys.path.insert(0, os.path.abspath('../../../web2py'))
# -- 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.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode']
# autosummary configuration
autosummary_generate = True
# intersphinx configuration
intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)}
# napoleon configuration
napoleon_user_rtype = False
# 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-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
now = datetime.now()
project = u'track_events API'
copyright = u'2012-%s, R. Le Gac, licensed under CeCILL' % now.year
author = u'R. Le Gac'
# 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 = get_version()
# The full version, including alpha/beta/rc tags.
release = version
# 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 patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# 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. See the documentation for
# a list of builtin themes.
html_theme = 'sphinxdoc'
# 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_domain_indices = 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, "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
# 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 = ''
# 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 = 'track_events_api_doc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
'pointsize': '11pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
(master_doc,
'track_events_api.tex',
u'track\\_events API',
u'R. Le Gac',
'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
# If true, show page references after internal links.
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'track_events_api', u'API',
[author], 1)
]
# If true, show URL addresses after external links.
# man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'track_events_api', u'track_events API',
author, 'track_events_api', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
report_objects.BaseReport.to_df
===============================
.. currentmodule:: report_objects
.. automethod:: BaseReport.to_df
\ No newline at end of file
callbacks.INHIBIT_CASCADE_DELETE
================================
.. currentmodule:: callbacks
.. autofunction:: INHIBIT_CASCADE_DELETE
\ No newline at end of file
report_objects.Graph.to_df
==========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_df
\ No newline at end of file
report_objects.Graph.to_pdf
===========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_pdf
\ No newline at end of file
report_objects.Graph.to_png
===========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_png
\ No newline at end of file
report_objects.Graph.to_svg
===========================
.. currentmodule:: report_objects
.. automethod:: Graph.to_svg
\ No newline at end of file
my_validators.IS_IN_USET.formatter
==================================
.. currentmodule:: my_validators
.. automethod:: IS_IN_USET.formatter
\ No newline at end of file
my_validators.IS_IN_USET.options
================================
.. currentmodule:: my_validators
.. automethod:: IS_IN_USET.options
\ No newline at end of file
report_objects.List.to_df
=========================
.. currentmodule:: report_objects
.. automethod:: List.to_df
\ No newline at end of file
report_objects.List.to_grid
===========================
.. currentmodule:: report_objects
.. automethod:: List.to_grid
\ No newline at end of file
report_objects.List.to_store
============================
.. currentmodule:: report_objects
.. automethod:: List.to_store
\ No newline at end of file
report_objects.Metric1D.to_df
=============================
.. currentmodule:: report_objects
.. automethod:: Metric1D.to_df
\ No newline at end of file
report_objects.Metric1D.to_grid
===============================
.. currentmodule:: report_objects
.. automethod:: Metric1D.to_grid
\ No newline at end of file
report_objects.Metric1D.to_store
================================
.. currentmodule:: report_objects
.. automethod:: Metric1D.to_store
\ No newline at end of file
report_objects.Metric2D.to_df
=============================
.. currentmodule:: report_objects
.. automethod:: Metric2D.to_df
\ No newline at end of file
report_objects.Metric2D.to_grid
===============================
.. currentmodule:: report_objects
.. automethod:: Metric2D.to_grid
\ No newline at end of file
report_objects.Metric2D.to_store
================================
.. currentmodule:: report_objects
.. automethod:: Metric2D.to_store
\ No newline at end of file
my_validators.IS_IN_USET
========================
.. currentmodule:: my_validators
.. autoclass:: IS_IN_USET
:show-inheritance:
.. autosummary::
:toctree: is_in_uset/
~IS_IN_USET.formatter
~IS_IN_USET.options
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment