|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# |
| 3 | +# Sphinx documentation build configuration file, created by |
| 4 | +# sphinx-quickstart.py on Sat Mar 8 21:47:50 2008. |
| 5 | +# |
| 6 | +# This file is execfile()d with the current directory set to its containing dir. |
| 7 | +# |
| 8 | +# The contents of this file are pickled, so don't put values in the namespace |
| 9 | +# that aren't pickleable (module imports are okay, they're removed automatically). |
| 10 | +# |
| 11 | +# All configuration values have a default value; values that are commented out |
| 12 | +# serve to show the default value. |
| 13 | + |
| 14 | +import sys |
| 15 | + |
| 16 | +# If your extensions are in another directory, add it here. |
| 17 | +sys.path.append('.') |
| 18 | + |
| 19 | +# General configuration |
| 20 | +# --------------------- |
| 21 | + |
| 22 | +# Add any Sphinx extension module names here, as strings. They can be extensions |
| 23 | +# coming with Sphinx (named 'sphinx.addons.*') or your custom ones. |
| 24 | +extensions = ['ext'] |
| 25 | + |
| 26 | +# Add any paths that contain templates here, relative to this directory. |
| 27 | +templates_path = ['.templates'] |
| 28 | + |
| 29 | +# The suffix of source filenames. |
| 30 | +source_suffix = '.rst' |
| 31 | + |
| 32 | +# The master toctree document. |
| 33 | +master_doc = 'contents' |
| 34 | + |
| 35 | +# General substitutions. |
| 36 | +project = 'Sphinx' |
| 37 | +copyright = '2008, Georg Brandl' |
| 38 | + |
| 39 | +# The default replacements for |version| and |release|, also used in various |
| 40 | +# other places throughout the built documents. |
| 41 | +# |
| 42 | +# The short X.Y version. |
| 43 | +version = '0.1' |
| 44 | +# The full version, including alpha/beta/rc tags. |
| 45 | +release = '0.1' |
| 46 | + |
| 47 | +# There are two options for replacing |today|: either, you set today to some |
| 48 | +# non-false value, then it is used: |
| 49 | +#today = '' |
| 50 | +# Else, today_fmt is used as the format for a strftime call. |
| 51 | +today_fmt = '%B %d, %Y' |
| 52 | + |
| 53 | +# List of documents that shouldn't be included in the build. |
| 54 | +#unused_docs = [] |
| 55 | + |
| 56 | +# If true, '()' will be appended to :func: etc. cross-reference text. |
| 57 | +#add_function_parentheses = True |
| 58 | + |
| 59 | +# If true, the current module name will be prepended to all description |
| 60 | +# unit titles (such as .. function::). |
| 61 | +#add_module_names = True |
| 62 | + |
| 63 | +show_authors = True |
| 64 | + |
| 65 | +# The name of the Pygments (syntax highlighting) style to use. |
| 66 | +pygments_style = 'friendly' |
| 67 | + |
| 68 | + |
| 69 | +# Options for HTML output |
| 70 | +# ----------------------- |
| 71 | + |
| 72 | +# The style sheet to use for HTML and HTML Help pages. A file of that name |
| 73 | +# must exist either in Sphinx' static/ path, or in one of the custom paths |
| 74 | +# given in html_static_path. |
| 75 | +html_style = 'sphinxdoc.css' |
| 76 | + |
| 77 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 78 | +# relative to this directory. They are copied after the builtin static files, |
| 79 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 80 | +html_static_path = ['.static'] |
| 81 | + |
| 82 | +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 83 | +# using the given strftime format. |
| 84 | +html_last_updated_fmt = '%b %d, %Y' |
| 85 | + |
| 86 | +# If true, SmartyPants will be used to convert quotes and dashes to |
| 87 | +# typographically correct entities. |
| 88 | +#html_use_smartypants = True |
| 89 | + |
| 90 | +# Content template for the index page. |
| 91 | +html_index = 'index.html' |
| 92 | + |
| 93 | +# Custom sidebar templates, maps page names to templates. |
| 94 | +html_sidebars = {'index': 'indexsidebar.html'} |
| 95 | + |
| 96 | +# Additional templates that should be rendered to pages, maps page names to |
| 97 | +# templates. |
| 98 | +#html_additional_pages = {} |
| 99 | + |
| 100 | +# If true, the reST sources are included in the HTML build as _sources/<name>. |
| 101 | +#html_copy_source = True |
| 102 | + |
| 103 | +# Output file base name for HTML help builder. |
| 104 | +htmlhelp_basename = 'Sphinxdoc' |
| 105 | + |
| 106 | + |
| 107 | +# Options for LaTeX output |
| 108 | +# ------------------------ |
| 109 | + |
| 110 | +# The paper size ('letter' or 'a4'). |
| 111 | +#latex_paper_size = 'letter' |
| 112 | + |
| 113 | +# The font size ('10pt', '11pt' or '12pt'). |
| 114 | +#latex_font_size = '10pt' |
| 115 | + |
| 116 | +# Grouping the document tree into LaTeX files. List of tuples |
| 117 | +# (source start file, target name, title, author, document class [howto/manual]). |
| 118 | +latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation', |
| 119 | + 'Georg Brandl', 'manual')] |
| 120 | + |
| 121 | +# Additional stuff for the LaTeX preamble. |
| 122 | +#latex_preamble = '' |
| 123 | + |
| 124 | +# Documents to append as an appendix to all manuals. |
| 125 | +#latex_appendices = [] |
0 commit comments