Added sphinx documentation

doc/Makefile

@@ -0,0 +1,154 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+#SPHINXBUILD   = python /home/lars/master-thesis/code/modules/core/venv/bin/sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Lernfunk3.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Lernfunk3.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Lernfunk3"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Lernfunk3"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

doc/_static/lernfunk.css

@@ -0,0 +1,91 @@
+@import url("haiku.css");
+
+dl.function > dt, dl.method > dt,dl.attribute > dt,  dl.class > dt, dl.get > dt, dl.post > dt, dl.put > dt, dl.delete > dt, dl.data > dt, div.apititle {
+	padding: 5px;
+	padding-left: 15px;
+	border-radius: 3px;
+	border-top: 1px solid gray;
+	background-color: silver;
+}
+
+dl.class {
+	border-left: 5px solid silver;
+	padding-bottom: 10px;
+	margin-bottom: 30px;
+}
+
+table.docutils td, table.docutils th, table.docutils tr {
+	border: none;
+}
+
+table.docutils thead tr {
+	border-bottom: 1px solid gray;
+}
+
+table.docutils {
+	border-top: 2px solid gray;
+	border-bottom: 2px solid gray;
+}
+
+div.apitoc {
+	border-bottom: 2px solid silver;
+	border-left: 10px solid silver;
+}
+
+div.apitoc a {
+	display: block;
+	padding: 0px;
+	padding-left: 10px;
+	color: black;
+}
+
+div.apitoc a:hover {
+	background-color: #eee;
+}
+
+div.apitoc a.second {
+	padding-left: 25px;
+}
+
+div.apitoc a.partOfClass {
+	padding-left: 25px;
+	border-left: 3px solid silver;
+	margin-left: 25px;
+}
+
+div.apitoc span.apilnclassname, div.apitoc big, div.apitoc em {
+	font-weight: lighter;
+}
+
+div.apitoc big, div.apitoc em {
+	color: #666;
+}
+
+div.apitoc span.apilnname {
+	font-weight: bold;
+}
+
+
+a.headerlink {
+	color: gray;
+}
+
+/*
+li.toctree-l3 {
+	display: inline-block;
+	min-width: 200px;
+	padding: 0px;
+	margin: 0px;
+}
+
+li.toctree-l3 a {
+	display: block;
+	margin: 1px 10px;
+	padding: 3px 10px;
+	border-radius: 3px;
+}
+
+li.toctree-l3 a:hover {
+	background-color: #eee;
+}
+*/

doc/_static/theme_extras.js

@@ -0,0 +1,28 @@
+$(document).ready(function() {
+	$('.headerlink').each(function( index ) {
+		var type = $(this).parent().get(0).nodeName
+		if (type == 'H1') {
+			var name = $(this).parent().get(0).childNodes[0].data;
+			var ln   = $(this).attr('href');
+			$('div.apitoc').append('<a href="'+ln+'">'+name+'</a>');
+		} else if (type == 'H2') {
+			var name = $(this).parent().get(0).childNodes[0].data;
+			var ln   = $(this).attr('href');
+			$('div.apitoc').append('<a class="h2" href="'+ln+'">'+name+'</a>');
+		} else if (type == 'DT') {
+			//var name = $(this).parent().text().replace('¶', '');
+			var name = $(this).parent().html().replace(/<a .*<\/a>/g, '')
+				.replace(/<tt class="desc/g, '<span class="apiln')
+				.replace(/<\/tt>/g, '</span>');
+			var ln   = $(this).attr('href');
+			var p = $(this).parent().parent();
+			if ( p.hasClass('method') || p.hasClass('attribute') ) {
+				$('div.apitoc').append('<a class="partOfClass" href="'+ln+'">'+name+'</a>');
+			} else {
+				$('div.apitoc').append('<a class="second" href="'+ln+'">'+name+'</a>');
+			}
+		} else {
+			alert( type );
+		}
+	});
+});

doc/api.entry.rst

@@ -0,0 +1,7 @@
+.. raw:: html
+
+   <div class="apititle"><b>Contents</b></div>
+   <div class="apitoc"></div>
+
+.. automodule:: feedgenerator.entry
+   :members:

doc/api.feed.rst

@@ -0,0 +1,7 @@
+.. raw:: html
+
+   <div class="apititle"><b>Contents</b></div>
+   <div class="apitoc"></div>
+
+.. automodule:: feedgenerator.feed
+   :members:

doc/api.podcast.rst

@@ -0,0 +1,7 @@
+.. raw:: html
+
+   <div class="apititle"><b>Contents</b></div>
+   <div class="apitoc"></div>
+
+.. automodule:: feedgenerator.podcast
+   :members:

doc/api.podcast_entry.rst

@@ -0,0 +1,7 @@
+.. raw:: html
+
+   <div class="apititle"><b>Contents</b></div>
+   <div class="apitoc"></div>
+
+.. automodule:: feedgenerator.podcast_entry
+   :members:

doc/api.rst

@@ -0,0 +1,17 @@
+=================
+API Documentation
+=================
+
+.. automodule:: feedgenerator
+   :members:
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   api.feed
+   api.entry
+   api.podcast
+   api.podcast_entry
+   api.util

doc/api.util.rst

@@ -0,0 +1,7 @@
+.. raw:: html
+
+   <div class="apititle"><b>Contents</b></div>
+   <div class="apitoc"></div>
+
+.. automodule:: feedgenerator.util
+   :members:

doc/conf.py

@@ -0,0 +1,268 @@
+# -*- coding: utf-8 -*-
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os, time
+
+# 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('.'))
+
+# -- 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.intersphinx',
+		'sphinx.ext.coverage',
+		'sphinx.ext.autodoc'
+	]
+
+# 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.
+project = u'pyFeedGenerator'
+copyright = u'2013, Lars Kiesow'
+
+# 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.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.s%s' % time.strftime('%Y%m%d')
+
+# 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 = 'default'
+html_theme = 'haiku'
+
+html_style = 'lernfunk.css'
+
+# 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 = '_static/logo.png'
+
+# 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 = 'pyFeedGenerator'
+
+
+# -- 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 = [
+	('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation',
+		u'Lars Kiesow', '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 = [
+	('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation',
+		[u'Lars Kiesow'], 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 = [
+	('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation',
+		u'Lars Kiesow', 'Lernfunk3', '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'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
+
+
+# Ugly way of setting tabsize
+import re
+
+def process_docstring(app, what, name, obj, options, lines):
+	'''
+	spaces_pat = re.compile(r"(?<=        )( {8})")
+	ll = []
+	for l in lines:
+		ll.append(spaces_pat.sub("   ",l))
+	'''
+	spaces_pat = re.compile(r"^ *")
+	ll = []
+	for l in lines:
+		spacelen = len(spaces_pat.search(l).group(0))
+		newlen = (spacelen % 8) + (spacelen / 8 * 4)
+		ll.append( (' '*newlen) + l.lstrip(' ') )
+	lines[:] = ll
+
+def setup(app):
+	app.connect('autodoc-process-docstring', process_docstring)

doc/index.rst

@@ -0,0 +1,25 @@
+.. contents:: Table of Contents
+
+.. include:: main-readme.rst
+
+.. raw:: html
+
+   <hr />
+
+====================
+Module documentation
+====================
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+==================
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/main-readme.rst

@@ -0,0 +1 @@
+../readme.md