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