commit bad7ae65902f648c3127de66a35a95223b6582a6 Author: Damian Johnson atagar@torproject.org Date: Sat Jun 2 11:41:54 2012 -0700
Configuring sphinx documentation attributes
Setting attributes and toggling attributes for the autogenerated sphinx documentation. This seems like a pretty slick tool, though I'm still puzzling out how to make it index all of stem. It seems to only register modules that I explicitely tell it about - I'm probably missing something...
Also still deciding between the default and haiku themes. Ruled out the others. --- docs/conf.py | 22 +++++++++++++--------- 1 files changed, 13 insertions(+), 9 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py index 1a4ab26..84ee9ed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,8 @@ 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('.')) + +sys.path.insert(0, os.path.abspath('..'))
# -- General configuration -----------------------------------------------------
@@ -39,18 +40,20 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index'
+from stem import __version__, __author__, __contact__ + # General information about the project. project = u'Stem' -copyright = u'2012, Damian Johnson' +copyright = u'2012, %s' % __author__
# 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.0' +version = __version__[:__version__.rfind(".")] # The full version, including alpha/beta/rc tags. -release = '0.0.1' +release = __version__
# The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -92,6 +95,7 @@ pygments_style = 'sphinx' # 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'
# 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 @@ -106,7 +110,7 @@ html_theme = 'default' #html_title = None
# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +html_short_title = 'Stem Docs'
# The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -147,13 +151,13 @@ html_static_path = ['_static'] #html_split_index = False
# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +html_show_copyright = False
# 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 @@ -212,5 +216,5 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'stem', u'Stem Documentation', - [u'Damian Johnson'], 1) + ['%s (%s)' % (__author__, __contact__)], 1) ]