|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# |
| 3 | +# fperez.org documentation build configuration file, created by |
| 4 | +# sphinx-quickstart on Thu Sep 17 23:10:43 2009. |
| 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 | + |
| 14 | +import 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 | +sys.path.append(os.path.abspath('sphinxext')) |
| 20 | + |
| 21 | +# -- General configuration ----------------------------------------------------- |
| 22 | + |
| 23 | +# Add any Sphinx extension module names here, as strings. They can be extensions |
| 24 | +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 25 | +extensions = ['sphinx.ext.doctest', |
| 26 | + 'sphinx.ext.todo', |
| 27 | + 'sphinx.ext.pngmath', |
| 28 | + 'sphinx.ext.ifconfig', |
| 29 | + |
| 30 | + 'ipython_console_highlighting', |
| 31 | + ] |
| 32 | + |
| 33 | +# Add any paths that contain templates here, relative to this directory. |
| 34 | +templates_path = ['_templates'] |
| 35 | + |
| 36 | +# The suffix of source filenames. |
| 37 | +source_suffix = '.rst' |
| 38 | + |
| 39 | +# The encoding of source files. |
| 40 | +#source_encoding = 'utf-8-sig' |
| 41 | + |
| 42 | +# The master toctree document. |
| 43 | +master_doc = 'index' |
| 44 | + |
| 45 | +# General information about the project. |
| 46 | +project = u'' |
| 47 | +copyright = u'2010, Fernando Pérez' |
| 48 | + |
| 49 | +# The version info for the project you're documenting, acts as replacement for |
| 50 | +# |version| and |release|, also used in various other places throughout the |
| 51 | +# built documents. |
| 52 | +# |
| 53 | +# The short X.Y version. |
| 54 | +version = '' |
| 55 | +# The full version, including alpha/beta/rc tags. |
| 56 | +release = '' |
| 57 | + |
| 58 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 59 | +# for a list of supported languages. |
| 60 | +#language = None |
| 61 | + |
| 62 | +# There are two options for replacing |today|: either, you set today to some |
| 63 | +# non-false value, then it is used: |
| 64 | +#today = '' |
| 65 | +# Else, today_fmt is used as the format for a strftime call. |
| 66 | +#today_fmt = '%B %d, %Y' |
| 67 | + |
| 68 | +# List of documents that shouldn't be included in the build. |
| 69 | +unused_docs = [] |
| 70 | + |
| 71 | +# List of directories, relative to source directory, that shouldn't be searched |
| 72 | +# for source files. |
| 73 | +exclude_trees = ['_build','.git','s','resources','attic','blog', |
| 74 | + 'code/lyxport/dist'] |
| 75 | + |
| 76 | +# The reST default role (used for this markup: `text`) to use for all documents. |
| 77 | +#default_role = None |
| 78 | + |
| 79 | +# If true, '()' will be appended to :func: etc. cross-reference text. |
| 80 | +#add_function_parentheses = True |
| 81 | + |
| 82 | +# If true, the current module name will be prepended to all description |
| 83 | +# unit titles (such as .. function::). |
| 84 | +#add_module_names = True |
| 85 | + |
| 86 | +# If true, sectionauthor and moduleauthor directives will be shown in the |
| 87 | +# output. They are ignored by default. |
| 88 | +#show_authors = False |
| 89 | + |
| 90 | +# The name of the Pygments (syntax highlighting) style to use. |
| 91 | +pygments_style = 'sphinx' |
| 92 | + |
| 93 | +# A list of ignored prefixes for module index sorting. |
| 94 | +#modindex_common_prefix = [] |
| 95 | + |
| 96 | + |
| 97 | +# -- Options for HTML output --------------------------------------------------- |
| 98 | + |
| 99 | +# The theme to use for HTML and HTML Help pages. Major themes that come with |
| 100 | +# Sphinx are currently 'default' and 'sphinxdoc'. |
| 101 | +#html_theme = 'default' |
| 102 | +#html_theme = 'sphinxdoc' |
| 103 | +html_theme = 'nature' # inherits from sphinxdoc and modifies it a little |
| 104 | + |
| 105 | +# The style sheet to use for HTML and HTML Help pages. A file of that name |
| 106 | +# must exist either in Sphinx' static/ path, or in one of the custom paths |
| 107 | +# given in html_static_path. |
| 108 | +html_style = 'nature.css' |
| 109 | + |
| 110 | +# Theme options are theme-specific and customize the look and feel of a theme |
| 111 | +# further. For a list of options available for each theme, see the |
| 112 | +# documentation. |
| 113 | +html_theme_options = {} |
| 114 | + |
| 115 | +# Only works with the default theme, makes the sidebar not scroll: |
| 116 | +#html_theme_options = { "stickysidebar": "true" } |
| 117 | + |
| 118 | +# Add any paths that contain custom themes here, relative to this directory. |
| 119 | +html_theme_path = ['themes'] |
| 120 | + |
| 121 | +# The name for this set of Sphinx documents. If None, it defaults to |
| 122 | +# "<project> v<release> documentation".ke |
| 123 | +html_title = u"Fernando Pérez" |
| 124 | + |
| 125 | +# A shorter title for the navigation bar. Default is the same as html_title. |
| 126 | +html_short_title = "Home" |
| 127 | + |
| 128 | +# The name of an image file (relative to this directory) to place at the top |
| 129 | +# of the sidebar. |
| 130 | +#html_logo = None |
| 131 | +#html_logo = "_static/top_mountains_clouds.jpg" |
| 132 | + |
| 133 | +# The name of an image file (within the static path) to use as favicon of the |
| 134 | +# pixels large. |
| 135 | +html_favicon = "favicon.ico" |
| 136 | + |
| 137 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 138 | +# relative to this directory. They are copied after the builtin static files, |
| 139 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 140 | +html_static_path = ['_static'] |
| 141 | + |
| 142 | +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 143 | +# using the given strftime format. |
| 144 | +#html_last_updated_fmt = '%b %d, %Y' |
| 145 | + |
| 146 | +# If true, SmartyPants will be used to convert quotes and dashes to |
| 147 | +# typographically correct entities. |
| 148 | +#html_use_smartypants = True |
| 149 | + |
| 150 | +# Custom sidebar templates, maps document names to template names. |
| 151 | +#html_sidebars = {} |
| 152 | + |
| 153 | +# Additional templates that should be rendered to pages, maps page names to |
| 154 | +# template names. |
| 155 | +#html_additional_pages = {} |
| 156 | + |
| 157 | +# If false, no module index is generated. |
| 158 | +html_use_modindex = False |
| 159 | + |
| 160 | +# If false, no index is generated. |
| 161 | +html_use_index = False |
| 162 | + |
| 163 | +# If true, the index is split into individual pages for each letter. |
| 164 | +#html_split_index = False |
| 165 | + |
| 166 | +# If true, links to the reST sources are added to the pages. |
| 167 | +#html_show_sourcelink = True |
| 168 | + |
| 169 | +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
| 170 | +#html_show_sphinx = True |
| 171 | + |
| 172 | +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
| 173 | +#html_show_copyright = True |
| 174 | + |
| 175 | +# If true, an OpenSearch description file will be output, and all pages will |
| 176 | +# contain a <link> tag referring to it. The value of this option must be the |
| 177 | +# base URL from which the finished HTML is served. |
| 178 | +#html_use_opensearch = '' |
| 179 | + |
| 180 | +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
| 181 | +#html_file_suffix = '' |
0 commit comments