Split stylesheets into basic, default and sphinxdoc.

doc/conf.py

@@ -1,26 +1,9 @@
 # -*- coding: utf-8 -*-
 #
-# Sphinx documentation build configuration file, created by
-# sphinx-quickstart.py on Sat Mar  8 21:47:50 2008.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# The contents of this file are pickled, so don't put values in the namespace
-# that aren't pickleable (module imports are okay, they're removed automatically).
-#
-# All configuration values have a default value; values that are commented out
-# serve to show the default value.
+# Sphinx documentation build configuration file
 
 import sys, os, re
 
-# If your extensions are in another directory, add it here.
-#sys.path.append(os.path.dirname(__file__))
-
-# General configuration
-# ---------------------
-
-language = 'en'
-
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.addons.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo']
@@ -40,42 +23,14 @@ copyright = '2007-2009, Georg Brandl'
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
-#
-# The short X.Y version.
 import sphinx
 version = sphinx.__released__
-# The full version, including alpha/beta/rc tags.
 release = version
 
-# 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 documents that shouldn't be included in the build.
-#unused_docs = []
-
-# 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
-
+# Show author directives in the output.
 show_authors = True
 
-# The name of the Pygments (syntax highlighting) style to use.
-#pygments_style = 'none'
-
-
-# Options for HTML output
-# -----------------------
-
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-#html_style = 'sphinxdoc.css'
+# The HTML template theme.
 html_theme = 'sphinxdoc'
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -87,10 +42,6 @@ html_static_path = ['_static']
 # 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
-
 # Content template for the index page.
 html_index = 'index.html'
 
@@ -101,50 +52,30 @@ html_sidebars = {'index': 'indexsidebar.html'}
 # templates.
 html_additional_pages = {'index': 'index.html'}
 
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
-
+# Generate an OpenSearch description with that URL as the base.
 html_use_opensearch = 'http://sphinx.pocoo.org'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Sphinxdoc'
 
-
-# Options for LaTeX output
-# ------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation',
                     'Georg Brandl', 'manual', 1)]
 
+# Add our logo to the LaTeX file.
 latex_logo = '_static/sphinx.png'
 
-#latex_use_parts = True
-
 # Additional stuff for the LaTeX preamble.
 latex_elements = {
     'fontpkg': '\\usepackage{palatino}'
 }
 
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-
-# Extension options
-# -----------------
-
+# Put TODOs into the output.
 todo_include_todos = True
 
 
-# Extension interface
-# -------------------
+# -- Extension interface -------------------------------------------------------
 
 from sphinx import addnodes
 
@@ -191,7 +122,8 @@ def parse_event(env, sig, signode):
 def setup(app):
     from sphinx.ext.autodoc import cut_lines
     app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
-    app.add_description_unit('directive', 'dir', 'pair: %s; directive', parse_directive)
+    app.add_description_unit('directive', 'dir', 'pair: %s; directive',
+                             parse_directive)
     app.add_description_unit('role', 'role', 'pair: %s; role', parse_role)
     app.add_description_unit('confval', 'confval', 'pair: %s; configuration value')
     app.add_description_unit('event', 'event', 'pair: %s; event', parse_event)