diff options
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/docs/conf.py b/docs/conf.py index f1f6f3b..1c8267f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ import sys, os options = os.environ.get("PASSLIB_DOCS", "").split(",") -#make sure passlib in sys.path +# make sure passlib in sys.path doc_root = os.path.abspath(os.path.join(__file__,os.path.pardir)) source_root = os.path.abspath(os.path.join(doc_root,os.path.pardir)) sys.path.insert(0, source_root) @@ -23,14 +23,14 @@ sys.path.insert(0, source_root) # 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('.')) -#building the docs requires the Cloud sphinx theme & extensions +# building the docs requires the Cloud sphinx theme & extensions # https://bitbucket.org/ecollins/cloud_sptheme -#which contains some sphinx extensions used by passlib +# which contains some sphinx extensions used by passlib import cloud_sptheme as csp -#hack to make autodoc generate documentation from the correct class... +# hack to make autodoc generate documentation from the correct class... import passlib.utils.md4 as md4_mod md4_mod.md4 = md4_mod._builtin_md4 @@ -46,13 +46,13 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.todo', - #add autdoc support for ReST sections in class/function docstrings + # add autdoc support for ReST sections in class/function docstrings 'cloud_sptheme.ext.autodoc_sections', - #adds extra ids & classes to genindex html, for additional styling + # adds extra ids & classes to genindex html, for additional styling 'cloud_sptheme.ext.index_styling', - #inserts toc into right hand nav bar (ala old style python docs) + # inserts toc into right hand nav bar (ala old style python docs) 'cloud_sptheme.ext.relbar_toc', # replace sphinx :samp: role handler with one that allows escaped {} chars @@ -91,13 +91,13 @@ version = csp.get_version(release) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +##language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +##today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +##today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -110,18 +110,18 @@ exclude_patterns = [ ] # The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +##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 +##add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +##show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' @@ -185,37 +185,37 @@ html_last_updated_fmt = '%b %d, %Y' html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +##html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +##html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +##html_domain_indices = True # If false, no index is generated. -#html_use_index = True +##html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +##html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +##html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +##html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = 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 = '' +##html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +##html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = project + 'Doc' @@ -224,10 +224,10 @@ htmlhelp_basename = project + 'Doc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +##latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +##latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). @@ -238,26 +238,26 @@ latex_documents = [ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +##latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +##latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +##latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +##latex_show_urls = False # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +##latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +##latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +##latex_domain_indices = True # -- Options for manual page output -------------------------------------------- |