1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/Makefile Sun Nov 02 16:46:42 2008 +0000
1.3 @@ -0,0 +1,70 @@
1.4 +# Makefile for Sphinx documentation
1.5 +#
1.6 +
1.7 +# You can set these variables from the command line.
1.8 +SPHINXOPTS =
1.9 +SPHINXBUILD = sphinx-build
1.10 +PAPER =
1.11 +
1.12 +# Internal variables.
1.13 +PAPEROPT_a4 = -D latex_paper_size=a4
1.14 +PAPEROPT_letter = -D latex_paper_size=letter
1.15 +ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1.16 +
1.17 +.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
1.18 +
1.19 +help:
1.20 + @echo "Please use \`make <target>' where <target> is one of"
1.21 + @echo " html to make standalone HTML files"
1.22 + @echo " pickle to make pickle files (usable by e.g. sphinx-web)"
1.23 + @echo " htmlhelp to make HTML files and a HTML help project"
1.24 + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
1.25 + @echo " changes to make an overview over all changed/added/deprecated items"
1.26 + @echo " linkcheck to check all external links for integrity"
1.27 +
1.28 +clean:
1.29 + -rm -rf _build/*
1.30 +
1.31 +html:
1.32 + mkdir -p _build/html _build/doctrees
1.33 + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
1.34 + @echo
1.35 + @echo "Build finished. The HTML pages are in _build/html."
1.36 +
1.37 +pickle:
1.38 + mkdir -p _build/pickle _build/doctrees
1.39 + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
1.40 + @echo
1.41 + @echo "Build finished; now you can process the pickle files or run"
1.42 + @echo " sphinx-web _build/pickle"
1.43 + @echo "to start the sphinx-web server."
1.44 +
1.45 +web: pickle
1.46 +
1.47 +htmlhelp:
1.48 + mkdir -p _build/htmlhelp _build/doctrees
1.49 + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
1.50 + @echo
1.51 + @echo "Build finished; now you can run HTML Help Workshop with the" \
1.52 + ".hhp project file in _build/htmlhelp."
1.53 +
1.54 +latex:
1.55 + mkdir -p _build/latex _build/doctrees
1.56 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
1.57 + @echo
1.58 + @echo "Build finished; the LaTeX files are in _build/latex."
1.59 + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
1.60 + "run these through (pdf)latex."
1.61 +
1.62 +changes:
1.63 + mkdir -p _build/changes _build/doctrees
1.64 + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
1.65 + @echo
1.66 + @echo "The overview file is in _build/changes."
1.67 +
1.68 +linkcheck:
1.69 + mkdir -p _build/linkcheck _build/doctrees
1.70 + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
1.71 + @echo
1.72 + @echo "Link check complete; look for any errors in the above output " \
1.73 + "or in _build/linkcheck/output.txt."
2.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
2.2 +++ b/docs/conf.py Sun Nov 02 16:46:42 2008 +0000
2.3 @@ -0,0 +1,179 @@
2.4 +# -*- coding: utf-8 -*-
2.5 +#
2.6 +# freeboxtv documentation build configuration file, created by
2.7 +# sphinx-quickstart on Sun Nov 2 17:46:18 2008.
2.8 +#
2.9 +# This file is execfile()d with the current directory set to its containing dir.
2.10 +#
2.11 +# The contents of this file are pickled, so don't put values in the namespace
2.12 +# that aren't pickleable (module imports are okay, they're removed automatically).
2.13 +#
2.14 +# All configuration values have a default value; values that are commented out
2.15 +# serve to show the default value.
2.16 +
2.17 +import sys, os
2.18 +
2.19 +# If your extensions are in another directory, add it here. If the directory
2.20 +# is relative to the documentation root, use os.path.abspath to make it
2.21 +# absolute, like shown here.
2.22 +#sys.path.append(os.path.abspath('some/directory'))
2.23 +
2.24 +# General configuration
2.25 +# ---------------------
2.26 +
2.27 +# Add any Sphinx extension module names here, as strings. They can be extensions
2.28 +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
2.29 +extensions = ['sphinx.ext.autodoc']
2.30 +
2.31 +# Add any paths that contain templates here, relative to this directory.
2.32 +templates_path = ['_templates']
2.33 +
2.34 +# The suffix of source filenames.
2.35 +source_suffix = '.txt'
2.36 +
2.37 +# The master toctree document.
2.38 +master_doc = 'index'
2.39 +
2.40 +# General substitutions.
2.41 +project = u'freeboxtv'
2.42 +copyright = u'2008, Gael Pasgrimaud'
2.43 +
2.44 +# The default replacements for |version| and |release|, also used in various
2.45 +# other places throughout the built documents.
2.46 +#
2.47 +# The short X.Y version.
2.48 +version = 'stable'
2.49 +# The full version, including alpha/beta/rc tags.
2.50 +release = 'stable'
2.51 +
2.52 +# There are two options for replacing |today|: either, you set today to some
2.53 +# non-false value, then it is used:
2.54 +#today = ''
2.55 +# Else, today_fmt is used as the format for a strftime call.
2.56 +today_fmt = '%B %d, %Y'
2.57 +
2.58 +# List of documents that shouldn't be included in the build.
2.59 +#unused_docs = []
2.60 +
2.61 +# List of directories, relative to source directories, that shouldn't be searched
2.62 +# for source files.
2.63 +exclude_trees = ['_build']
2.64 +
2.65 +# The reST default role (used for this markup: `text`) to use for all documents.
2.66 +#default_role = None
2.67 +
2.68 +# If true, '()' will be appended to :func: etc. cross-reference text.
2.69 +#add_function_parentheses = True
2.70 +
2.71 +# If true, the current module name will be prepended to all description
2.72 +# unit titles (such as .. function::).
2.73 +#add_module_names = True
2.74 +
2.75 +# If true, sectionauthor and moduleauthor directives will be shown in the
2.76 +# output. They are ignored by default.
2.77 +#show_authors = False
2.78 +
2.79 +# The name of the Pygments (syntax highlighting) style to use.
2.80 +pygments_style = 'sphinx'
2.81 +
2.82 +
2.83 +# Options for HTML output
2.84 +# -----------------------
2.85 +
2.86 +# The style sheet to use for HTML and HTML Help pages. A file of that name
2.87 +# must exist either in Sphinx' static/ path, or in one of the custom paths
2.88 +# given in html_static_path.
2.89 +html_style = 'default.css'
2.90 +
2.91 +# The name for this set of Sphinx documents. If None, it defaults to
2.92 +# "<project> v<release> documentation".
2.93 +#html_title = None
2.94 +
2.95 +# A shorter title for the navigation bar. Default is the same as html_title.
2.96 +#html_short_title = None
2.97 +
2.98 +# The name of an image file (relative to this directory) to place at the top
2.99 +# of the sidebar.
2.100 +#html_logo = None
2.101 +
2.102 +# The name of an image file (within the static path) to use as favicon of the
2.103 +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
2.104 +# pixels large.
2.105 +#html_favicon = None
2.106 +
2.107 +# Add any paths that contain custom static files (such as style sheets) here,
2.108 +# relative to this directory. They are copied after the builtin static files,
2.109 +# so a file named "default.css" will overwrite the builtin "default.css".
2.110 +html_static_path = ['_static']
2.111 +
2.112 +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
2.113 +# using the given strftime format.
2.114 +html_last_updated_fmt = '%b %d, %Y'
2.115 +
2.116 +# If true, SmartyPants will be used to convert quotes and dashes to
2.117 +# typographically correct entities.
2.118 +#html_use_smartypants = True
2.119 +
2.120 +# Custom sidebar templates, maps document names to template names.
2.121 +#html_sidebars = {}
2.122 +
2.123 +# Additional templates that should be rendered to pages, maps page names to
2.124 +# template names.
2.125 +#html_additional_pages = {}
2.126 +
2.127 +# If false, no module index is generated.
2.128 +#html_use_modindex = True
2.129 +
2.130 +# If false, no index is generated.
2.131 +#html_use_index = True
2.132 +
2.133 +# If true, the index is split into individual pages for each letter.
2.134 +#html_split_index = False
2.135 +
2.136 +# If true, the reST sources are included in the HTML build as _sources/<name>.
2.137 +#html_copy_source = True
2.138 +
2.139 +# If true, an OpenSearch description file will be output, and all pages will
2.140 +# contain a <link> tag referring to it. The value of this option must be the
2.141 +# base URL from which the finished HTML is served.
2.142 +#html_use_opensearch = ''
2.143 +
2.144 +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
2.145 +#html_file_suffix = ''
2.146 +
2.147 +# Output file base name for HTML help builder.
2.148 +htmlhelp_basename = 'freeboxtvdoc'
2.149 +
2.150 +
2.151 +# Options for LaTeX output
2.152 +# ------------------------
2.153 +
2.154 +# The paper size ('letter' or 'a4').
2.155 +#latex_paper_size = 'letter'
2.156 +
2.157 +# The font size ('10pt', '11pt' or '12pt').
2.158 +#latex_font_size = '10pt'
2.159 +
2.160 +# Grouping the document tree into LaTeX files. List of tuples
2.161 +# (source start file, target name, title, author, document class [howto/manual]).
2.162 +latex_documents = [
2.163 + ('index', 'freeboxtv.tex', u'freeboxtv Documentation',
2.164 + u'Gael Pasgrimaud', 'manual'),
2.165 +]
2.166 +
2.167 +# The name of an image file (relative to this directory) to place at the top of
2.168 +# the title page.
2.169 +#latex_logo = None
2.170 +
2.171 +# For "manual" documents, if this is true, then toplevel headings are parts,
2.172 +# not chapters.
2.173 +#latex_use_parts = False
2.174 +
2.175 +# Additional stuff for the LaTeX preamble.
2.176 +#latex_preamble = ''
2.177 +
2.178 +# Documents to append as an appendix to all manuals.
2.179 +#latex_appendices = []
2.180 +
2.181 +# If false, no module index is generated.
2.182 +#latex_use_modindex = True
3.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
3.2 +++ b/docs/index.txt Sun Nov 02 16:46:42 2008 +0000
3.3 @@ -0,0 +1,19 @@
3.4 +.. freeboxtv documentation master file, created by sphinx-quickstart on Sun Nov 2 17:46:18 2008.
3.5 + You can adapt this file completely to your liking, but it should at least
3.6 + contain the root `toctree` directive.
3.7 +
3.8 +Welcome to freeboxtv's documentation!
3.9 +=====================================
3.10 +
3.11 +Contents:
3.12 +
3.13 +.. toctree::
3.14 + :maxdepth: 2
3.15 +
3.16 +Indices and tables
3.17 +==================
3.18 +
3.19 +* :ref:`genindex`
3.20 +* :ref:`modindex`
3.21 +* :ref:`search`
3.22 +