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

Polish documentation.

parent 429a78c1
......@@ -78,6 +78,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
app = 'track_events'
now = datetime.now()
project = u'track_events API'
copyright = u'2012-%s, R. Le Gac, licensed under CeCILL' % now.year
......@@ -204,7 +205,7 @@ html_theme = 'sphinxdoc'
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'track_events_api_doc'
htmlhelp_basename = '%s_api_doc' % app
# -- Options for LaTeX output --------------------------------------------------
......@@ -218,14 +219,23 @@ latex_elements = {
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
# Latex figure (float) alignment
'figure_align': 'htb',
# fancy chapter title
'fncychap': '\\usepackage[Glenn]{fncychap}',
# Use the Computer Modern fonts instead of Times and Helvetica
'fontpkg': ''
}
# 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',
'%s_api.tex' % app,
u'%s API documentation' % app.replace('_', '\\_'),
u'R. Le Gac',
'manual'),
]
......@@ -256,7 +266,7 @@ latex_documents = [
# 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',
(master_doc, '%s_api' %app, u'%s API' % app,
[author], 1)
]
......@@ -270,8 +280,8 @@ man_pages = [
# (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.',
(master_doc, str(app), u'%s API' % app,
author, '%s_api' % app, 'Documentation for the Python API.',
'Miscellaneous'),
]
......
plugin_event.Event.initialise_paths
===================================
.. currentmodule:: plugin_event
.. automethod:: Event.initialise_paths
\ No newline at end of file
plugin_event.Event
==================
.. currentmodule:: plugin_event
.. autoclass:: Event
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: model/
~Event.initialise_paths
......@@ -9,6 +9,7 @@ A collection of classes to define the model for the database.
.. autosummary::
:toctree: generated/
Event
EvtModelCore
EvtModelReport
EvtModelSelector
\ No newline at end of file
......@@ -200,6 +200,16 @@ latex_elements = {
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Latex figure (float) alignment
'figure_align': 'htb',
# fancy chapter title
'fncychap': '\\usepackage[Glenn]{fncychap}',
# Use the Computer Modern fonts instead of Times and Helvetica
'fontpkg': ''
}
# Grouping the document tree into LaTeX files. List of tuples
......
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