Michael Mayer / ctools

Browse Code »

Commit 5beee8153ff3618bb61814333e4dcdd447f6a11b

Authored by Jürgen Knödlseder 2014-01-09 18:01:47 +0100

1 parent a28eb5d6

Add Sphinx documentation

Inline Side-by-side

Showing 14 changed files with 817 additions and 0 deletions

doc/source/_static/logo.png 0 → 100644

View file @5beee81

11.4 KB

doc/source/_templates/index.html 0 → 100644

View file @5beee81

	1	+{% extends "layout.html" %} {% set title = _('Overview') %} {% block
	2	+body %}
	3	+<h1>{{ _('ctools') }}</h1>
	4	+
	5	+<h2 style="margin-bottom: 0">{%trans%}About{%endtrans%}</h2>
	6	+
	7	+<p>{%trans%} ctools are a set of ftools-like executables needed for the scientific analysis
	8	+of Cherenkov Telescope Array data. ctools is also a Python module
	9	+that allows for interactive data analysis and building of analysis
	10	+scripts and pipelines. ctools includes also an observation simulator
	11	+to enable the scientific simulation of future CTA observations. {%endtrans%}</p>
	12	+
	13	+<p>{%trans%} ctools are based on GammaLib, a versatile toolbox for
	14	+the high-level analysis of astronomical gamma-ray data. Besides CTA,
	15	+GammaLib supports also the analysis of Fermi-LAT data, and extensions
	16	+to support further gamma-ray instruments are planned. This enables a
	17	+simultaneous and coherent multi-instrument analysis of high-energy
	18	+sources in the Universe. {%endtrans%}</p>
	19	+
	20	+<p>{%trans%} ctools is free software distributed under the
	21	+<a href="http://www.gnu.org/licenses/gpl.html">GNU GPL license version 3</a> {%endtrans%}</p>
	22	+
	23	+<h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2>
	24	+
	25	+<ul>
	26	+<li><a class="smalllink" href="{{ pathto("installation") }}">{%trans%}Installation{%endtrans%}</a></li>
	27	+<li><a class="smalllink" href="{{ pathto("quickstart") }}">{%trans%}Quickstart{%endtrans%}</a></li>
	28	+<li><a class="smalllink" href="{{ pathto("documentation") }}">{%trans%}ctools reference{%endtrans%}</a></li>
	29	+<li><a class="smalllink" href="doxygen/index.html">{%trans%}Code documentation{%endtrans%}</a></li>
	30	+</ul>
	31	+
	32	+<h2 style="margin-bottom: 0">{%trans%}Links{%endtrans%}</h2>
	33	+
	34	+<ul>
	35	+ <li><a href="https://cta-redmine.irap.omp.eu/projects/ctools">Developer's pages</a>{% endblock %}</li>
	36	+</ul>
...	...

doc/source/_themes/sphinx13/layout.html 0 → 100644

View file @5beee81

	1	+{#
	2	+ sphinxdoc/layout.html
	3	+ ~~~~~~~~~~~~~~~~~~~~~
	4	+
	5	+ Sphinx layout template for the sphinxdoc theme.
	6	+
	7	+ :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
	8	+ :license: BSD, see LICENSE for details.
	9	+#}
	10	+{%- extends "basic/layout.html" %}
	11	+
	12	+{# put the sidebar before the body #}
	13	+{% block sidebar1 %}{{ sidebar() }}{% endblock %}
	14	+{% block sidebar2 %}{% endblock %}
	15	+
	16	+{% block extrahead %}
	17	+ <link href='http://fonts.googleapis.com/css?family=Open+Sans:300,400,700'
	18	+ rel='stylesheet' type='text/css'>
	19	+ {# Add the google webfonts needed for the logo #}
	20	+ <link href='http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600'
	21	+ rel='stylesheet' type='text/css'>
	22	+{{ super() }}
	23	+{%- if not embedded %}
	24	+ <style type="text/css">
	25	+ table.right { float: right; margin-left: 20px; }
	26	+ table.right td { border: 1px solid #ccc; }
	27	+ {% if pagename == 'index' %}
	28	+ .related { display: none; }
	29	+ {% endif %}
	30	+ </style>
	31	+ <script type="text/javascript">
	32	+ // intelligent scrolling of the sidebar content
	33	+ $(window).scroll(function() {
	34	+ var sb = $('.sphinxsidebarwrapper');
	35	+ var win = $(window);
	36	+ var sbh = sb.height();
	37	+ var offset = $('.sphinxsidebar').position()['top'];
	38	+ var wintop = win.scrollTop();
	39	+ var winbot = wintop + win.innerHeight();
	40	+ var curtop = sb.position()['top'];
	41	+ var curbot = curtop + sbh;
	42	+ // does sidebar fit in window?
	43	+ if (sbh < win.innerHeight()) {
	44	+ // yes: easy case -- always keep at the top
	45	+ sb.css('top', $u.min([$u.max([0, wintop - offset - 10]),
	46	+ $(document).height() - sbh - 200]));
	47	+ } else {
	48	+ // no: only scroll if top/bottom edge of sidebar is at
	49	+ // top/bottom edge of window
	50	+ if (curtop > wintop && curbot > winbot) {
	51	+ sb.css('top', $u.max([wintop - offset - 10, 0]));
	52	+ } else if (curtop < wintop && curbot < winbot) {
	53	+ sb.css('top', $u.min([winbot - sbh - offset - 20,
	54	+ $(document).height() - sbh - 200]));
	55	+ }
	56	+ }
	57	+ });
	58	+ </script>
	59	+{%- endif %}
	60	+{% endblock %}
	61	+
	62	+{% block rootrellink %}
	63	+ <li><a href="{{ pathto('index') }}">Home</a> \|</li>
	64	+ <li><a href="{{ pathto('contents') }}">Documentation</a> »</li>
	65	+{% endblock %}
	66	+
	67	+{% block header %}
	68	+<div class="pageheader">
	69	+ <ul>
	70	+ <li><a href="{{ pathto('index') }}">Home</a></li>
	71	+ <li><a href="{{ pathto('installation') }}">Get it</a></li>
	72	+ <li><a href="{{ pathto('contents') }}">Docs</a></li>
	73	+ <li><a href="{{ pathto('develop') }}">Extend/Develop</a></li>
	74	+ </ul>
	75	+ <div>
	76	+ <a href="{{ pathto('index') }}">
	77	+ <div class=banner_part>
	78	+ <img src="{{ pathto('_static/logo.png', 1) }}" height="64" alt="SPHINX" />
	79	+ </div>
	80	+ <div class=banner_part>
	81	+ <span id="banner_text1"> </span><br/>
	82	+ <span id="banner_text2"> Imaging Air Cherenkov telescope science analysis software</span>
	83	+ </div>
	84	+ </a>
	85	+ </div>
	86	+</div>
	87	+{% endblock %}
...	...

doc/source/_themes/sphinx13/static/bodybg.png 0 → 100644

View file @5beee81

602 Bytes

doc/source/_themes/sphinx13/static/footerbg.png 0 → 100644

View file @5beee81

313 Bytes

doc/source/_themes/sphinx13/static/headerbg.png 0 → 100644

View file @5beee81

344 Bytes

doc/source/_themes/sphinx13/static/listitem.png 0 → 100644

View file @5beee81

207 Bytes

doc/source/_themes/sphinx13/static/relbg.png 0 → 100644

View file @5beee81

332 Bytes

doc/source/_themes/sphinx13/static/sphinx13.css 0 → 100644

View file @5beee81

	1	+/*
	2	+ * sphinx13.css
	3	+ * ~~~~~~~~~~~~
	4	+ *
	5	+ * Sphinx stylesheet -- sphinx13 theme.
	6	+ *
	7	+ * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
	8	+ * :license: BSD, see LICENSE for details.
	9	+ *
	10	+ */
	11	+
	12	+@import url("basic.css");
	13	+
	14	+/* -- page layout ----------------------------------------------------------- */
	15	+
	16	+body {
	17	+ font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
	18	+ 'Verdana', sans-serif;
	19	+ font-size: 14px;
	20	+ text-align: center;
	21	+ background-image: url(bodybg.png);
	22	+ color: black;
	23	+ padding: 0;
	24	+ border-right: 1px solid #0a507a;
	25	+ border-left: 1px solid #0a507a;
	26	+
	27	+ margin: 0 auto;
	28	+ min-width: 780px;
	29	+ max-width: 1080px;
	30	+}
	31	+
	32	+.pageheader {
	33	+ background-image: url(headerbg.png);
	34	+ text-align: left;
	35	+ padding: 10px 15px;
	36	+}
	37	+
	38	+.pageheader ul {
	39	+ float: right;
	40	+ color: white;
	41	+ list-style-type: none;
	42	+ padding-left: 0;
	43	+ margin-top: 30px;
	44	+ margin-right: 10px;
	45	+}
	46	+
	47	+.pageheader li {
	48	+ float: left;
	49	+ margin: 0 0 0 10px;
	50	+}
	51	+
	52	+.pageheader li a {
	53	+ border-radius: 1px;
	54	+ padding: 8px 12px;
	55	+ color: #f9f9f0;
	56	+ text-shadow: 0 0 5px rgba(0, 0, 0, 0.5);
	57	+}
	58	+
	59	+.pageheader li a:hover {
	60	+ background-color: #f9f9f0;
	61	+ color: #0a507a;
	62	+ text-shadow: none;
	63	+}
	64	+
	65	+div.document {
	66	+ background-color: white;
	67	+ text-align: left;
	68	+}
	69	+
	70	+div.bodywrapper {
	71	+ margin: 0 240px 0 0;
	72	+ border-right: 1px solid #0a507a;
	73	+}
	74	+
	75	+div.body {
	76	+ margin: 0;
	77	+ padding: 0.5em 20px 20px 20px;
	78	+}
	79	+
	80	+div.related {
	81	+ font-size: 1em;
	82	+ color: white;
	83	+}
	84	+
	85	+div.related ul {
	86	+ background-image: url(relbg.png);
	87	+ height: 1.9em;
	88	+ border-top: 1px solid #002e50;
	89	+ border-bottom: 1px solid #002e50;
	90	+}
	91	+
	92	+div.related ul li {
	93	+ margin: 0 5px 0 0;
	94	+ padding: 0;
	95	+ float: left;
	96	+}
	97	+
	98	+div.related ul li.right {
	99	+ float: right;
	100	+ margin-right: 5px;
	101	+}
	102	+
	103	+div.related ul li a {
	104	+ margin: 0;
	105	+ padding: 0 5px 0 5px;
	106	+ line-height: 1.75em;
	107	+ color: #f9f9f0;
	108	+ text-shadow: 0px 0px 1px rgba(0, 0, 0, 0.5);
	109	+}
	110	+
	111	+div.related ul li a:hover {
	112	+ color: white;
	113	+ /text-decoration: underline;/
	114	+ text-shadow: 0px 0px 1px rgba(255, 255, 255, 0.5);
	115	+}
	116	+
	117	+div.sphinxsidebarwrapper {
	118	+ position: relative;
	119	+ top: 0px;
	120	+ padding: 0;
	121	+}
	122	+
	123	+div.sphinxsidebar {
	124	+ margin: 0;
	125	+ padding: 0 15px 15px 0;
	126	+ width: 210px;
	127	+ float: right;
	128	+ font-size: 1em;
	129	+ text-align: left;
	130	+}
	131	+
	132	+div.sphinxsidebar .logo {
	133	+ font-size: 1.8em;
	134	+ color: #0A507A;
	135	+ font-weight: 300;
	136	+ text-align: center;
	137	+}
	138	+
	139	+div.sphinxsidebar .logo img {
	140	+ vertical-align: middle;
	141	+}
	142	+
	143	+div.sphinxsidebar input {
	144	+ border: 1px solid #aaa;
	145	+ font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
	146	+ 'Verdana', sans-serif;
	147	+ font-size: 1em;
	148	+}
	149	+
	150	+div.sphinxsidebar h3 {
	151	+ font-size: 1.5em;
	152	+ border-top: 1px solid #0a507a;
	153	+ margin-top: 1em;
	154	+ margin-bottom: 0.5em;
	155	+ padding-top: 0.5em;
	156	+}
	157	+
	158	+div.sphinxsidebar h4 {
	159	+ font-size: 1.2em;
	160	+ margin-bottom: 0;
	161	+}
	162	+
	163	+div.sphinxsidebar h3, div.sphinxsidebar h4 {
	164	+ margin-right: -15px;
	165	+ margin-left: -15px;
	166	+ padding-right: 14px;
	167	+ padding-left: 14px;
	168	+ color: #333;
	169	+ font-weight: 300;
	170	+ /text-shadow: 0px 0px 0.5px rgba(0, 0, 0, 0.4);/
	171	+}
	172	+
	173	+div.sphinxsidebarwrapper > h3:first-child {
	174	+ margin-top: 0.5em;
	175	+ border: none;
	176	+}
	177	+
	178	+div.sphinxsidebar h3 a {
	179	+ color: #333;
	180	+}
	181	+
	182	+div.sphinxsidebar ul {
	183	+ color: #444;
	184	+ margin-top: 7px;
	185	+ padding: 0;
	186	+ line-height: 130%;
	187	+}
	188	+
	189	+div.sphinxsidebar ul ul {
	190	+ margin-left: 20px;
	191	+ list-style-image: url(listitem.png);
	192	+}
	193	+
	194	+div.footer {
	195	+ background-image: url(footerbg.png);
	196	+ color: #ccc;
	197	+ text-shadow: 0 0 .2px rgba(255, 255, 255, 0.8);
	198	+ padding: 3px 8px 3px 0;
	199	+ clear: both;
	200	+ font-size: 0.8em;
	201	+ text-align: right;
	202	+}
	203	+
	204	+/* no need to make a visible link to Sphinx on the Sphinx page */
	205	+div.footer a {
	206	+ color: #ccc;
	207	+}
	208	+
	209	+/* -- body styles ----------------------------------------------------------- */
	210	+
	211	+p {
	212	+ margin: 0.8em 0 0.5em 0;
	213	+}
	214	+
	215	+a {
	216	+ color: #A2881D;
	217	+ text-decoration: none;
	218	+}
	219	+
	220	+a:hover {
	221	+ color: #E1C13F;
	222	+}
	223	+
	224	+div.body a {
	225	+ text-decoration: underline;
	226	+}
	227	+
	228	+h1 {
	229	+ margin: 10px 0 0 0;
	230	+ font-size: 2.4em;
	231	+ color: #0A507A;
	232	+ font-weight: 300;
	233	+}
	234	+
	235	+h2 {
	236	+ margin: 1.em 0 0.2em 0;
	237	+ font-size: 1.5em;
	238	+ font-weight: 300;
	239	+ padding: 0;
	240	+ color: #174967;
	241	+}
	242	+
	243	+h3 {
	244	+ margin: 1em 0 -0.3em 0;
	245	+ font-size: 1.3em;
	246	+ font-weight: 300;
	247	+}
	248	+
	249	+div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a {
	250	+ text-decoration: none;
	251	+}
	252	+
	253	+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 {
	254	+ color: #0A507A !important;
	255	+ font-size: inherit !important;
	256	+}
	257	+
	258	+a.headerlink {
	259	+ color: #0A507A !important;
	260	+ font-size: 12px;
	261	+ margin-left: 6px;
	262	+ padding: 0 4px 0 4px;
	263	+ text-decoration: none !important;
	264	+ float: right;
	265	+}
	266	+
	267	+a.headerlink:hover {
	268	+ background-color: #ccc;
	269	+ color: white!important;
	270	+}
	271	+
	272	+cite, code, tt {
	273	+ font-family: 'Consolas', 'DejaVu Sans Mono',
	274	+ 'Bitstream Vera Sans Mono', monospace;
	275	+ font-size: 14px;
	276	+ letter-spacing: -0.02em;
	277	+}
	278	+
	279	+tt {
	280	+ background-color: #f2f2f2;
	281	+ border: 1px solid #ddd;
	282	+ border-radius: 2px;
	283	+ color: #333;
	284	+ padding: 1px;
	285	+}
	286	+
	287	+tt.descname, tt.descclassname, tt.xref {
	288	+ border: 0;
	289	+}
	290	+
	291	+hr {
	292	+ border: 1px solid #abc;
	293	+ margin: 2em;
	294	+}
	295	+
	296	+a tt {
	297	+ border: 0;
	298	+ color: #a2881d;
	299	+}
	300	+
	301	+a tt:hover {
	302	+ color: #e1c13f;
	303	+}
	304	+
	305	+pre {
	306	+ font-family: 'Consolas', 'DejaVu Sans Mono',
	307	+ 'Bitstream Vera Sans Mono', monospace;
	308	+ font-size: 13px;
	309	+ letter-spacing: 0.015em;
	310	+ line-height: 120%;
	311	+ padding: 0.5em;
	312	+ border: 1px solid #ccc;
	313	+ border-radius: 2px;
	314	+ background-color: #f8f8f8;
	315	+}
	316	+
	317	+pre a {
	318	+ color: inherit;
	319	+ text-decoration: underline;
	320	+}
	321	+
	322	+td.linenos pre {
	323	+ padding: 0.5em 0;
	324	+}
	325	+
	326	+div.quotebar {
	327	+ background-color: #f8f8f8;
	328	+ max-width: 250px;
	329	+ float: right;
	330	+ padding: 0px 7px;
	331	+ border: 1px solid #ccc;
	332	+ margin-left: 1em;
	333	+}
	334	+
	335	+div.topic {
	336	+ background-color: #f8f8f8;
	337	+}
	338	+
	339	+table {
	340	+ border-collapse: collapse;
	341	+ margin: 0 -0.5em 0 -0.5em;
	342	+}
	343	+
	344	+table td, table th {
	345	+ padding: 0.2em 0.5em 0.2em 0.5em;
	346	+}
	347	+
	348	+div.admonition, div.warning {
	349	+ font-size: 0.9em;
	350	+ margin: 1em 0 1em 0;
	351	+ border: 1px solid #86989B;
	352	+ border-radius: 2px;
	353	+ background-color: #f7f7f7;
	354	+ padding: 0;
	355	+}
	356	+
	357	+div.admonition p, div.warning p {
	358	+ margin: 0.5em 1em 0.5em 1em;
	359	+ padding: 0;
	360	+}
	361	+
	362	+div.admonition pre, div.warning pre {
	363	+ margin: 0.4em 1em 0.4em 1em;
	364	+}
	365	+
	366	+div.admonition p.admonition-title,
	367	+div.warning p.admonition-title {
	368	+ margin-top: 1em;
	369	+ padding-top: 0.5em;
	370	+ font-weight: bold;
	371	+}
	372	+
	373	+div.warning {
	374	+ border: 1px solid #940000;
	375	+/* background-color: #FFCCCF;*/
	376	+}
	377	+
	378	+div.warning p.admonition-title {
	379	+}
	380	+
	381	+div.admonition ul, div.admonition ol,
	382	+div.warning ul, div.warning ol {
	383	+ margin: 0.1em 0.5em 0.5em 3em;
	384	+ padding: 0;
	385	+}
	386	+
	387	+.viewcode-back {
	388	+ font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
	389	+ 'Verdana', sans-serif;
	390	+}
	391	+
	392	+div.viewcode-block:target {
	393	+ background-color: #f4debf;
	394	+ border-top: 1px solid #ac9;
	395	+ border-bottom: 1px solid #ac9;
	396	+}
	397	+
	398	+div.banner_part {
	399	+ display: inline-block;
	400	+}
	401	+
	402	+#banner_text1 {
	403	+ font-size: 30px;
	404	+ font-weight: 400;
	405	+ color: #ffffff;
	406	+}
	407	+
	408	+#banner_text2 {
	409	+ font-size: 15px;
	410	+ font-weight: 200;
	411	+ color: #ffffff;
	412	+}
...	...

doc/source/_themes/sphinx13/theme.conf 0 → 100644

View file @5beee81

	1	+[theme]
	2	+inherit = basic
	3	+stylesheet = sphinx13.css
	4	+pygments_style = trac
...	...

doc/source/conf.py 0 → 100644

View file @5beee81

	1	+# -- coding: utf-8 --
	2	+#
	3	+# ctools documentation build configuration file, created by
	4	+# sphinx-quickstart on Sat Apr 13 16:41:07 2013.
	5	+#
	6	+# This file is execfile()d with the current directory set to its containing dir.
	7	+#
	8	+# Note that not all possible configuration values are present in this
	9	+# autogenerated file.
	10	+#
	11	+# All configuration values have a default; values that are commented out
	12	+# serve to show the default.
	13	+
	14	+import sys, os
	15	+
	16	+# If extensions (or modules to document with autodoc) are in another directory,
	17	+# add these directories to sys.path here. If the directory is relative to the
	18	+# documentation root, use os.path.abspath to make it absolute, like shown here.
	19	+#sys.path.insert(0, os.path.abspath('.'))
	20	+
	21	+# -- General configuration -----------------------------------------------------
	22	+
	23	+# If your documentation needs a minimal Sphinx version, state it here.
	24	+#needs_sphinx = '1.0'
	25	+
	26	+# Add any Sphinx extension module names here, as strings. They can be extensions
	27	+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
	28	+extensions = ['sphinx.ext.mathjax']
	29	+
	30	+# Add any paths that contain templates here, relative to this directory.
	31	+templates_path = ['_templates']
	32	+
	33	+# The suffix of source filenames.
	34	+source_suffix = '.rst'
	35	+
	36	+# The encoding of source files.
	37	+#source_encoding = 'utf-8-sig'
	38	+
	39	+# The master toctree document.
	40	+master_doc = 'contents'
	41	+
	42	+# General information about the project.
	43	+project = u'ctools'
	44	+copyright = u'2014, ctools developers'
	45	+
	46	+# The version info for the project you're documenting, acts as replacement for
	47	+# \|version\| and \|release\|, also used in various other places throughout the
	48	+# built documents.
	49	+#
	50	+# The short X.Y version.
	51	+version = '0.7'
	52	+
	53	+# The full version, including alpha/beta/rc tags.
	54	+release = '0.7'
	55	+
	56	+# The language for content autogenerated by Sphinx. Refer to documentation
	57	+# for a list of supported languages.
	58	+#language = None
	59	+
	60	+# There are two options for replacing \|today\|: either, you set today to some
	61	+# non-false value, then it is used:
	62	+#today = ''
	63	+# Else, today_fmt is used as the format for a strftime call.
	64	+#today_fmt = '%B %d, %Y'
	65	+
	66	+# List of patterns, relative to source directory, that match files and
	67	+# directories to ignore when looking for source files.
	68	+exclude_patterns = []
	69	+
	70	+# The reST default role (used for this markup: `text`) to use for all documents.
	71	+#default_role = None
	72	+
	73	+# If true, '()' will be appended to :func: etc. cross-reference text.
	74	+#add_function_parentheses = True
	75	+
	76	+# If true, the current module name will be prepended to all description
	77	+# unit titles (such as .. function::).
	78	+#add_module_names = True
	79	+
	80	+# If true, sectionauthor and moduleauthor directives will be shown in the
	81	+# output. They are ignored by default.
	82	+#show_authors = False
	83	+
	84	+# The name of the Pygments (syntax highlighting) style to use.
	85	+pygments_style = 'sphinx'
	86	+
	87	+# A list of ignored prefixes for module index sorting.
	88	+#modindex_common_prefix = []
	89	+
	90	+
	91	+# -- Options for HTML output ---------------------------------------------------
	92	+
	93	+# The theme to use for HTML and HTML Help pages. See the documentation for
	94	+# a list of builtin themes.
	95	+html_theme = 'sphinx13'
	96	+
	97	+# Theme options are theme-specific and customize the look and feel of a theme
	98	+# further. For a list of options available for each theme, see the
	99	+# documentation.
	100	+#html_theme_options = {}
	101	+
	102	+# Add any paths that contain custom themes here, relative to this directory.
	103	+html_theme_path = ['_themes']
	104	+
	105	+# The name for this set of Sphinx documents. If None, it defaults to
	106	+# "<project> v<release> documentation".
	107	+#html_title = None
	108	+
	109	+# A shorter title for the navigation bar. Default is the same as html_title.
	110	+#html_short_title = None
	111	+
	112	+# The name of an image file (relative to this directory) to place at the top
	113	+# of the sidebar.
	114	+#html_logo = None
	115	+
	116	+# The name of an image file (within the static path) to use as favicon of the
	117	+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
	118	+# pixels large.
	119	+html_favicon = 'favicon.png'
	120	+
	121	+# Add any paths that contain custom static files (such as style sheets) here,
	122	+# relative to this directory. They are copied after the builtin static files,
	123	+# so a file named "default.css" will overwrite the builtin "default.css".
	124	+html_static_path = ['_static']
	125	+
	126	+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
	127	+# using the given strftime format.
	128	+html_last_updated_fmt = '%b %d, %Y'
	129	+
	130	+# If true, SmartyPants will be used to convert quotes and dashes to
	131	+# typographically correct entities.
	132	+#html_use_smartypants = True
	133	+
	134	+# Custom sidebar templates, maps document names to template names.
	135	+#html_sidebars = {}
	136	+
	137	+# Additional templates that should be rendered to pages, maps page names to
	138	+# template names.
	139	+html_additional_pages = {'index': 'index.html'}
	140	+
	141	+# If false, no module index is generated.
	142	+html_domain_indices = False
	143	+
	144	+# If false, no index is generated.
	145	+#html_use_index = True
	146	+
	147	+# If true, the index is split into individual pages for each letter.
	148	+#html_split_index = False
	149	+
	150	+# If true, links to the reST sources are added to the pages.
	151	+html_show_sourcelink = False
	152	+
	153	+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
	154	+html_show_sphinx = False
	155	+
	156	+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
	157	+html_show_copyright = False
	158	+
	159	+# If true, an OpenSearch description file will be output, and all pages will
	160	+# contain a <link> tag referring to it. The value of this option must be the
	161	+# base URL from which the finished HTML is served.
	162	+#html_use_opensearch = ''
	163	+
	164	+# This is the file name suffix for HTML files (e.g. ".xhtml").
	165	+#html_file_suffix = None
	166	+
	167	+# Output file base name for HTML help builder.
	168	+htmlhelp_basename = 'GammaLibdoc'
	169	+
	170	+
	171	+# -- Options for LaTeX output --------------------------------------------------
	172	+
	173	+latex_elements = {
	174	+# The paper size ('letterpaper' or 'a4paper').
	175	+#'papersize': 'letterpaper',
	176	+
	177	+# The font size ('10pt', '11pt' or '12pt').
	178	+#'pointsize': '10pt',
	179	+
	180	+# Additional stuff for the LaTeX preamble.
	181	+#'preamble': '',
	182	+}
	183	+
	184	+# Grouping the document tree into LaTeX files. List of tuples
	185	+# (source start file, target name, title, author, documentclass [howto/manual]).
	186	+latex_documents = [
	187	+ ('contents', 'ctools.tex', u'ctools Documentation',
	188	+ u'ctools developers', 'manual'),
	189	+]
	190	+
	191	+# The name of an image file (relative to this directory) to place at the top of
	192	+# the title page.
	193	+#latex_logo = None
	194	+
	195	+# For "manual" documents, if this is true, then toplevel headings are parts,
	196	+# not chapters.
	197	+#latex_use_parts = False
	198	+
	199	+# If true, show page references after internal links.
	200	+#latex_show_pagerefs = False
	201	+
	202	+# If true, show URL addresses after external links.
	203	+#latex_show_urls = False
	204	+
	205	+# Documents to append as an appendix to all manuals.
	206	+#latex_appendices = []
	207	+
	208	+# If false, no module index is generated.
	209	+#latex_domain_indices = True
	210	+
	211	+
	212	+# -- Options for manual page output --------------------------------------------
	213	+
	214	+# One entry per manual page. List of tuples
	215	+# (source start file, name, description, authors, manual section).
	216	+man_pages = [
	217	+ ('contents', 'ctools', u'ctools Documentation',
	218	+ [u'ctools developers'], 1)
	219	+]
	220	+
	221	+# If true, show URL addresses after external links.
	222	+#man_show_urls = False
	223	+
	224	+
	225	+# -- Options for Texinfo output ------------------------------------------------
	226	+
	227	+# Grouping the document tree into Texinfo files. List of tuples
	228	+# (source start file, target name, title, author,
	229	+# dir menu entry, description, category)
	230	+texinfo_documents = [
	231	+ ('contents', 'ctools', u'ctools Documentation',
	232	+ u'ctools developers', 'ctools', 'One line description of project.',
	233	+ 'Miscellaneous'),
	234	+]
	235	+
	236	+# Documents to append as an appendix to all manuals.
	237	+#texinfo_appendices = []
	238	+
	239	+# If false, no module index is generated.
	240	+#texinfo_domain_indices = True
	241	+
	242	+# How to display URL addresses: 'footnote', 'no', or 'inline'.
	243	+#texinfo_show_urls = 'footnote'
...	...

doc/source/contents.rst 0 → 100644

View file @5beee81

	1	+.. ctools documentation master file, created by
	2	+ sphinx-quickstart on Sat Apr 13 16:41:07 2013.
	3	+ You can adapt this file completely to your liking, but it should at least
	4	+ contain the root `toctree` directive.
	5	+
	6	+Documentation
	7	+=============
	8	+
	9	+.. toctree::
	10	+ :maxdepth: 2
	11	+
	12	+ test
	13	+ develop
0	14	\ No newline at end of file
...	...

doc/source/develop.rst 0 → 100644

View file @5beee81

	1	+Develop
	2	+=======
	3	+
	4	+Please help developing.
0	5	\ No newline at end of file
...	...

doc/source/test.rst 0 → 100644

View file @5beee81

	1	+Test page
	2	+=========
	3	+
	4	+ctools are a set of ftools-like executables needed for the scientific analysis
	5	+of Cherenkov Telescope Array data. ctools is also a Python module
	6	+that allows for interactive data analysis and building of analysis
	7	+scripts and pipelines. ctools includes also an observation simulator
	8	+to enable the scientific simulation of future CTA observations.
	9	+
	10	+ctools are based on GammaLib, a versatile toolbox for
	11	+the high-level analysis of astronomical gamma-ray data. Besides CTA,
	12	+GammaLib supports also the analysis of Fermi-LAT data, and extensions
	13	+to support further gamma-ray instruments are planned. This enables a
	14	+simultaneous and coherent multi-instrument analysis of high-energy
	15	+sources in the Universe.
	16	+
	17	+ctools is free software distributed under the
	18	+`GNU GPL license version 3 <http://www.gnu.org/licenses/gpl.html>`_
...	...