From 5beee8153ff3618bb61814333e4dcdd447f6a11b Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Thu, 9 Jan 2014 18:01:47 +0100 Subject: [PATCH] Add Sphinx documentation --- doc/source/_static/logo.png | Bin 0 -> 11712 bytes doc/source/_templates/index.html | 36 ++++++++++++++++++++++++++++++++++++ doc/source/_themes/sphinx13/layout.html | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/_themes/sphinx13/static/bodybg.png | Bin 0 -> 602 bytes doc/source/_themes/sphinx13/static/footerbg.png | Bin 0 -> 313 bytes doc/source/_themes/sphinx13/static/headerbg.png | Bin 0 -> 344 bytes doc/source/_themes/sphinx13/static/listitem.png | Bin 0 -> 207 bytes doc/source/_themes/sphinx13/static/relbg.png | Bin 0 -> 332 bytes doc/source/_themes/sphinx13/static/sphinx13.css | 412 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/_themes/sphinx13/theme.conf | 4 ++++ doc/source/conf.py | 243 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/contents.rst | 13 +++++++++++++ doc/source/develop.rst | 4 ++++ doc/source/test.rst | 18 ++++++++++++++++++ 14 files changed, 817 insertions(+), 0 deletions(-) create mode 100644 doc/source/_static/logo.png create mode 100644 doc/source/_templates/index.html create mode 100644 doc/source/_themes/sphinx13/layout.html create mode 100644 doc/source/_themes/sphinx13/static/bodybg.png create mode 100644 doc/source/_themes/sphinx13/static/footerbg.png create mode 100644 doc/source/_themes/sphinx13/static/headerbg.png create mode 100644 doc/source/_themes/sphinx13/static/listitem.png create mode 100644 doc/source/_themes/sphinx13/static/relbg.png create mode 100644 doc/source/_themes/sphinx13/static/sphinx13.css create mode 100644 doc/source/_themes/sphinx13/theme.conf create mode 100644 doc/source/conf.py create mode 100644 doc/source/contents.rst create mode 100644 doc/source/develop.rst create mode 100644 doc/source/test.rst diff --git a/doc/source/_static/logo.png b/doc/source/_static/logo.png new file mode 100644 index 0000000..4337467 Binary files /dev/null and b/doc/source/_static/logo.png differ diff --git a/doc/source/_templates/index.html b/doc/source/_templates/index.html new file mode 100644 index 0000000..ab81e3b --- /dev/null +++ b/doc/source/_templates/index.html @@ -0,0 +1,36 @@ +{% extends "layout.html" %} {% set title = _('Overview') %} {% block +body %} +

{{ _('ctools') }}

+ +

{%trans%}About{%endtrans%}

+ +

{%trans%} ctools are a set of ftools-like executables needed for the scientific analysis +of Cherenkov Telescope Array data. ctools is also a Python module +that allows for interactive data analysis and building of analysis +scripts and pipelines. ctools includes also an observation simulator +to enable the scientific simulation of future CTA observations. {%endtrans%}

+ +

{%trans%} ctools are based on GammaLib, a versatile toolbox for +the high-level analysis of astronomical gamma-ray data. Besides CTA, +GammaLib supports also the analysis of Fermi-LAT data, and extensions +to support further gamma-ray instruments are planned. This enables a +simultaneous and coherent multi-instrument analysis of high-energy +sources in the Universe. {%endtrans%}

+ +

{%trans%} ctools is free software distributed under the +GNU GPL license version 3 {%endtrans%}

+ +

{%trans%}Documentation{%endtrans%}

+ + + +

{%trans%}Links{%endtrans%}

+ + diff --git a/doc/source/_themes/sphinx13/layout.html b/doc/source/_themes/sphinx13/layout.html new file mode 100644 index 0000000..bd6eec0 --- /dev/null +++ b/doc/source/_themes/sphinx13/layout.html @@ -0,0 +1,87 @@ +{# + sphinxdoc/layout.html + ~~~~~~~~~~~~~~~~~~~~~ + + Sphinx layout template for the sphinxdoc theme. + + :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- extends "basic/layout.html" %} + +{# put the sidebar before the body #} +{% block sidebar1 %}{{ sidebar() }}{% endblock %} +{% block sidebar2 %}{% endblock %} + +{% block extrahead %} + + {# Add the google webfonts needed for the logo #} + +{{ super() }} +{%- if not embedded %} + + +{%- endif %} +{% endblock %} + +{% block rootrellink %} +
  • Home |
    • +
  • Documentation »
    • +{% endblock %} + +{% block header %} +
    + +
    + + + + +
    +
    +{% endblock %} diff --git a/doc/source/_themes/sphinx13/static/bodybg.png b/doc/source/_themes/sphinx13/static/bodybg.png new file mode 100644 index 0000000..506b6f9 Binary files /dev/null and b/doc/source/_themes/sphinx13/static/bodybg.png differ diff --git a/doc/source/_themes/sphinx13/static/footerbg.png b/doc/source/_themes/sphinx13/static/footerbg.png new file mode 100644 index 0000000..d1922b4 Binary files /dev/null and b/doc/source/_themes/sphinx13/static/footerbg.png differ diff --git a/doc/source/_themes/sphinx13/static/headerbg.png b/doc/source/_themes/sphinx13/static/headerbg.png new file mode 100644 index 0000000..6d3e1d5 Binary files /dev/null and b/doc/source/_themes/sphinx13/static/headerbg.png differ diff --git a/doc/source/_themes/sphinx13/static/listitem.png b/doc/source/_themes/sphinx13/static/listitem.png new file mode 100644 index 0000000..e45715f Binary files /dev/null and b/doc/source/_themes/sphinx13/static/listitem.png differ diff --git a/doc/source/_themes/sphinx13/static/relbg.png b/doc/source/_themes/sphinx13/static/relbg.png new file mode 100644 index 0000000..4722585 Binary files /dev/null and b/doc/source/_themes/sphinx13/static/relbg.png differ diff --git a/doc/source/_themes/sphinx13/static/sphinx13.css b/doc/source/_themes/sphinx13/static/sphinx13.css new file mode 100644 index 0000000..4bcae04 --- /dev/null +++ b/doc/source/_themes/sphinx13/static/sphinx13.css @@ -0,0 +1,412 @@ +/* + * sphinx13.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- sphinx13 theme. + * + * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 14px; + text-align: center; + background-image: url(bodybg.png); + color: black; + padding: 0; + border-right: 1px solid #0a507a; + border-left: 1px solid #0a507a; + + margin: 0 auto; + min-width: 780px; + max-width: 1080px; +} + +.pageheader { + background-image: url(headerbg.png); + text-align: left; + padding: 10px 15px; +} + +.pageheader ul { + float: right; + color: white; + list-style-type: none; + padding-left: 0; + margin-top: 30px; + margin-right: 10px; +} + +.pageheader li { + float: left; + margin: 0 0 0 10px; +} + +.pageheader li a { + border-radius: 1px; + padding: 8px 12px; + color: #f9f9f0; + text-shadow: 0 0 5px rgba(0, 0, 0, 0.5); +} + +.pageheader li a:hover { + background-color: #f9f9f0; + color: #0a507a; + text-shadow: none; +} + +div.document { + background-color: white; + text-align: left; +} + +div.bodywrapper { + margin: 0 240px 0 0; + border-right: 1px solid #0a507a; +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} + +div.related { + font-size: 1em; + color: white; +} + +div.related ul { + background-image: url(relbg.png); + height: 1.9em; + border-top: 1px solid #002e50; + border-bottom: 1px solid #002e50; +} + +div.related ul li { + margin: 0 5px 0 0; + padding: 0; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + +div.related ul li a { + margin: 0; + padding: 0 5px 0 5px; + line-height: 1.75em; + color: #f9f9f0; + text-shadow: 0px 0px 1px rgba(0, 0, 0, 0.5); +} + +div.related ul li a:hover { + color: white; + /*text-decoration: underline;*/ + text-shadow: 0px 0px 1px rgba(255, 255, 255, 0.5); +} + +div.sphinxsidebarwrapper { + position: relative; + top: 0px; + padding: 0; +} + +div.sphinxsidebar { + margin: 0; + padding: 0 15px 15px 0; + width: 210px; + float: right; + font-size: 1em; + text-align: left; +} + +div.sphinxsidebar .logo { + font-size: 1.8em; + color: #0A507A; + font-weight: 300; + text-align: center; +} + +div.sphinxsidebar .logo img { + vertical-align: middle; +} + +div.sphinxsidebar input { + border: 1px solid #aaa; + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 1em; +} + +div.sphinxsidebar h3 { + font-size: 1.5em; + border-top: 1px solid #0a507a; + margin-top: 1em; + margin-bottom: 0.5em; + padding-top: 0.5em; +} + +div.sphinxsidebar h4 { + font-size: 1.2em; + margin-bottom: 0; +} + +div.sphinxsidebar h3, div.sphinxsidebar h4 { + margin-right: -15px; + margin-left: -15px; + padding-right: 14px; + padding-left: 14px; + color: #333; + font-weight: 300; + /*text-shadow: 0px 0px 0.5px rgba(0, 0, 0, 0.4);*/ +} + +div.sphinxsidebarwrapper > h3:first-child { + margin-top: 0.5em; + border: none; +} + +div.sphinxsidebar h3 a { + color: #333; +} + +div.sphinxsidebar ul { + color: #444; + margin-top: 7px; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + margin-left: 20px; + list-style-image: url(listitem.png); +} + +div.footer { + background-image: url(footerbg.png); + color: #ccc; + text-shadow: 0 0 .2px rgba(255, 255, 255, 0.8); + padding: 3px 8px 3px 0; + clear: both; + font-size: 0.8em; + text-align: right; +} + +/* no need to make a visible link to Sphinx on the Sphinx page */ +div.footer a { + color: #ccc; +} + +/* -- body styles ----------------------------------------------------------- */ + +p { + margin: 0.8em 0 0.5em 0; +} + +a { + color: #A2881D; + text-decoration: none; +} + +a:hover { + color: #E1C13F; +} + +div.body a { + text-decoration: underline; +} + +h1 { + margin: 10px 0 0 0; + font-size: 2.4em; + color: #0A507A; + font-weight: 300; +} + +h2 { + margin: 1.em 0 0.2em 0; + font-size: 1.5em; + font-weight: 300; + padding: 0; + color: #174967; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.3em; + font-weight: 300; +} + +div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { + text-decoration: none; +} + +div.body h1 a tt, div.body h2 a tt, div.body h3 a tt, div.body h4 a tt, div.body h5 a tt, div.body h6 a tt { + color: #0A507A !important; + font-size: inherit !important; +} + +a.headerlink { + color: #0A507A !important; + font-size: 12px; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none !important; + float: right; +} + +a.headerlink:hover { + background-color: #ccc; + color: white!important; +} + +cite, code, tt { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 14px; + letter-spacing: -0.02em; +} + +tt { + background-color: #f2f2f2; + border: 1px solid #ddd; + border-radius: 2px; + color: #333; + padding: 1px; +} + +tt.descname, tt.descclassname, tt.xref { + border: 0; +} + +hr { + border: 1px solid #abc; + margin: 2em; +} + +a tt { + border: 0; + color: #a2881d; +} + +a tt:hover { + color: #e1c13f; +} + +pre { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 13px; + letter-spacing: 0.015em; + line-height: 120%; + padding: 0.5em; + border: 1px solid #ccc; + border-radius: 2px; + background-color: #f8f8f8; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +td.linenos pre { + padding: 0.5em 0; +} + +div.quotebar { + background-color: #f8f8f8; + max-width: 250px; + float: right; + padding: 0px 7px; + border: 1px solid #ccc; + margin-left: 1em; +} + +div.topic { + background-color: #f8f8f8; +} + +table { + border-collapse: collapse; + margin: 0 -0.5em 0 -0.5em; +} + +table td, table th { + padding: 0.2em 0.5em 0.2em 0.5em; +} + +div.admonition, div.warning { + font-size: 0.9em; + margin: 1em 0 1em 0; + border: 1px solid #86989B; + border-radius: 2px; + background-color: #f7f7f7; + padding: 0; +} + +div.admonition p, div.warning p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition pre, div.warning pre { + margin: 0.4em 1em 0.4em 1em; +} + +div.admonition p.admonition-title, +div.warning p.admonition-title { + margin-top: 1em; + padding-top: 0.5em; + font-weight: bold; +} + +div.warning { + border: 1px solid #940000; +/* background-color: #FFCCCF;*/ +} + +div.warning p.admonition-title { +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + +.viewcode-back { + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} + +div.banner_part { + display: inline-block; +} + +#banner_text1 { + font-size: 30px; + font-weight: 400; + color: #ffffff; +} + +#banner_text2 { + font-size: 15px; + font-weight: 200; + color: #ffffff; +} diff --git a/doc/source/_themes/sphinx13/theme.conf b/doc/source/_themes/sphinx13/theme.conf new file mode 100644 index 0000000..876b198 --- /dev/null +++ b/doc/source/_themes/sphinx13/theme.conf @@ -0,0 +1,4 @@ +[theme] +inherit = basic +stylesheet = sphinx13.css +pygments_style = trac diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..e127e11 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,243 @@ +# -*- coding: utf-8 -*- +# +# ctools documentation build configuration file, created by +# sphinx-quickstart on Sat Apr 13 16:41:07 2013. +# +# 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.insert(0, os.path.abspath('.')) + +# -- 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.mathjax'] + +# 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 = 'contents' + +# General information about the project. +project = u'ctools' +copyright = u'2014, ctools developers' + +# 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 = '0.7' + +# The full version, including alpha/beta/rc tags. +release = '0.7' + +# 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 = [] + +# 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 = 'sphinx13' + +# 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 = ['_themes'] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v 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 = 'favicon.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 + +# 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 = {'index': 'index.html'} + +# If false, no module index is generated. +html_domain_indices = False + +# 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 = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +html_show_copyright = False + +# If true, an OpenSearch description file will be output, and all pages will +# contain a 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 = 'GammaLibdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# 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 = [ + ('contents', 'ctools.tex', u'ctools Documentation', + u'ctools developers', '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 = [ + ('contents', 'ctools', u'ctools Documentation', + [u'ctools developers'], 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 = [ + ('contents', 'ctools', u'ctools Documentation', + u'ctools developers', 'ctools', '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' diff --git a/doc/source/contents.rst b/doc/source/contents.rst new file mode 100644 index 0000000..0ffa46b --- /dev/null +++ b/doc/source/contents.rst @@ -0,0 +1,13 @@ +.. ctools documentation master file, created by + sphinx-quickstart on Sat Apr 13 16:41:07 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Documentation +============= + +.. toctree:: + :maxdepth: 2 + + test + develop \ No newline at end of file diff --git a/doc/source/develop.rst b/doc/source/develop.rst new file mode 100644 index 0000000..5d6a9b9 --- /dev/null +++ b/doc/source/develop.rst @@ -0,0 +1,4 @@ +Develop +======= + +Please help developing. \ No newline at end of file diff --git a/doc/source/test.rst b/doc/source/test.rst new file mode 100644 index 0000000..94028f2 --- /dev/null +++ b/doc/source/test.rst @@ -0,0 +1,18 @@ +Test page +========= + +ctools are a set of ftools-like executables needed for the scientific analysis +of Cherenkov Telescope Array data. ctools is also a Python module +that allows for interactive data analysis and building of analysis +scripts and pipelines. ctools includes also an observation simulator +to enable the scientific simulation of future CTA observations. + +ctools are based on GammaLib, a versatile toolbox for +the high-level analysis of astronomical gamma-ray data. Besides CTA, +GammaLib supports also the analysis of Fermi-LAT data, and extensions +to support further gamma-ray instruments are planned. This enables a +simultaneous and coherent multi-instrument analysis of high-energy +sources in the Universe. + +ctools is free software distributed under the +`GNU GPL license version 3 `_ -- libgit2 0.21.4