python/virtualenv/docs/conf.py@b8a032363ba2 (annotated)
python/virtualenv/docs/conf.py
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | # -*- coding: utf-8 -*- |
| michael@0 | 2 | # |
| michael@0 | 3 | # Paste documentation build configuration file, created by |
| michael@0 | 4 | # sphinx-quickstart on Tue Apr 22 22:08:49 2008. |
| michael@0 | 5 | # |
| michael@0 | 6 | # This file is execfile()d with the current directory set to its containing dir. |
| michael@0 | 7 | # |
| michael@0 | 8 | # The contents of this file are pickled, so don't put values in the namespace |
| michael@0 | 9 | # that aren't pickleable (module imports are okay, they're removed automatically). |
| michael@0 | 10 | # |
| michael@0 | 11 | # All configuration values have a default value; values that are commented out |
| michael@0 | 12 | # serve to show the default value. |
| michael@0 | 13 | |
| michael@0 | 14 | import os |
| michael@0 | 15 | import sys |
| michael@0 | 16 | |
| michael@0 | 17 | on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| michael@0 | 18 | |
| michael@0 | 19 | # If your extensions are in another directory, add it here. |
| michael@0 | 20 | sys.path.insert(0, os.path.abspath(os.pardir)) |
| michael@0 | 21 | |
| michael@0 | 22 | # General configuration |
| michael@0 | 23 | # --------------------- |
| michael@0 | 24 | |
| michael@0 | 25 | # Add any Sphinx extension module names here, as strings. They can be extensions |
| michael@0 | 26 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| michael@0 | 27 | extensions = ['sphinx.ext.autodoc'] |
| michael@0 | 28 | |
| michael@0 | 29 | # Add any paths that contain templates here, relative to this directory. |
| michael@0 | 30 | ## FIXME: disabled for now because I haven't figured out how to use this: |
| michael@0 | 31 | #templates_path = ['_templates'] |
| michael@0 | 32 | |
| michael@0 | 33 | # The suffix of source filenames. |
| michael@0 | 34 | source_suffix = '.rst' |
| michael@0 | 35 | |
| michael@0 | 36 | # The master toctree document. |
| michael@0 | 37 | master_doc = 'index' |
| michael@0 | 38 | |
| michael@0 | 39 | # General substitutions. |
| michael@0 | 40 | project = 'virtualenv' |
| michael@0 | 41 | copyright = '2007-2014, Ian Bicking, The Open Planning Project, PyPA' |
| michael@0 | 42 | |
| michael@0 | 43 | # The default replacements for |version| and |release|, also used in various |
| michael@0 | 44 | # other places throughout the built documents. |
| michael@0 | 45 | try: |
| michael@0 | 46 | from virtualenv import __version__ |
| michael@0 | 47 | # The short X.Y version. |
| michael@0 | 48 | version = '.'.join(__version__.split('.')[:2]) |
| michael@0 | 49 | # The full version, including alpha/beta/rc tags. |
| michael@0 | 50 | release = __version__ |
| michael@0 | 51 | except ImportError: |
| michael@0 | 52 | version = release = 'dev' |
| michael@0 | 53 | |
| michael@0 | 54 | # There are two options for replacing |today|: either, you set today to some |
| michael@0 | 55 | # non-false value, then it is used: |
| michael@0 | 56 | #today = '' |
| michael@0 | 57 | # Else, today_fmt is used as the format for a strftime call. |
| michael@0 | 58 | today_fmt = '%B %d, %Y' |
| michael@0 | 59 | |
| michael@0 | 60 | # List of documents that shouldn't be included in the build. |
| michael@0 | 61 | unused_docs = [] |
| michael@0 | 62 | |
| michael@0 | 63 | # If true, '()' will be appended to :func: etc. cross-reference text. |
| michael@0 | 64 | #add_function_parentheses = True |
| michael@0 | 65 | |
| michael@0 | 66 | # If true, the current module name will be prepended to all description |
| michael@0 | 67 | # unit titles (such as .. function::). |
| michael@0 | 68 | #add_module_names = True |
| michael@0 | 69 | |
| michael@0 | 70 | # If true, sectionauthor and moduleauthor directives will be shown in the |
| michael@0 | 71 | # output. They are ignored by default. |
| michael@0 | 72 | #show_authors = False |
| michael@0 | 73 | |
| michael@0 | 74 | # The name of the Pygments (syntax highlighting) style to use. |
| michael@0 | 75 | pygments_style = 'sphinx' |
| michael@0 | 76 | |
| michael@0 | 77 | |
| michael@0 | 78 | # Options for HTML output |
| michael@0 | 79 | # ----------------------- |
| michael@0 | 80 | |
| michael@0 | 81 | # The style sheet to use for HTML and HTML Help pages. A file of that name |
| michael@0 | 82 | # must exist either in Sphinx' static/ path, or in one of the custom paths |
| michael@0 | 83 | # given in html_static_path. |
| michael@0 | 84 | #html_style = 'default.css' |
| michael@0 | 85 | |
| michael@0 | 86 | if os.environ.get('DOCS_LOCAL'): |
| michael@0 | 87 | import sphinx_rtd_theme |
| michael@0 | 88 | html_theme = "sphinx_rtd_theme" |
| michael@0 | 89 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| michael@0 | 90 | else: |
| michael@0 | 91 | # on RTD |
| michael@0 | 92 | html_theme = 'default' |
| michael@0 | 93 | |
| michael@0 | 94 | |
| michael@0 | 95 | # Add any paths that contain custom static files (such as style sheets) here, |
| michael@0 | 96 | # relative to this directory. They are copied after the builtin static files, |
| michael@0 | 97 | # so a file named "default.css" will overwrite the builtin "default.css". |
| michael@0 | 98 | # html_static_path = ['_static'] |
| michael@0 | 99 | |
| michael@0 | 100 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| michael@0 | 101 | # using the given strftime format. |
| michael@0 | 102 | html_last_updated_fmt = '%b %d, %Y' |
| michael@0 | 103 | |
| michael@0 | 104 | # If true, SmartyPants will be used to convert quotes and dashes to |
| michael@0 | 105 | # typographically correct entities. |
| michael@0 | 106 | #html_use_smartypants = True |
| michael@0 | 107 | |
| michael@0 | 108 | # Content template for the index page. |
| michael@0 | 109 | #html_index = '' |
| michael@0 | 110 | |
| michael@0 | 111 | # Custom sidebar templates, maps document names to template names. |
| michael@0 | 112 | #html_sidebars = {} |
| michael@0 | 113 | |
| michael@0 | 114 | # Additional templates that should be rendered to pages, maps page names to |
| michael@0 | 115 | # template names. |
| michael@0 | 116 | #html_additional_pages = {} |
| michael@0 | 117 | |
| michael@0 | 118 | # If false, no module index is generated. |
| michael@0 | 119 | #html_use_modindex = True |
| michael@0 | 120 | |
| michael@0 | 121 | # If true, the reST sources are included in the HTML build as _sources/<name>. |
| michael@0 | 122 | #html_copy_source = True |
| michael@0 | 123 | |
| michael@0 | 124 | # Output file base name for HTML help builder. |
| michael@0 | 125 | htmlhelp_basename = 'Pastedoc' |
| michael@0 | 126 | |
| michael@0 | 127 | |
| michael@0 | 128 | # Options for LaTeX output |
| michael@0 | 129 | # ------------------------ |
| michael@0 | 130 | |
| michael@0 | 131 | # The paper size ('letter' or 'a4'). |
| michael@0 | 132 | #latex_paper_size = 'letter' |
| michael@0 | 133 | |
| michael@0 | 134 | # The font size ('10pt', '11pt' or '12pt'). |
| michael@0 | 135 | #latex_font_size = '10pt' |
| michael@0 | 136 | |
| michael@0 | 137 | # Grouping the document tree into LaTeX files. List of tuples |
| michael@0 | 138 | # (source start file, target name, title, author, document class [howto/manual]). |
| michael@0 | 139 | #latex_documents = [] |
| michael@0 | 140 | |
| michael@0 | 141 | # Additional stuff for the LaTeX preamble. |
| michael@0 | 142 | #latex_preamble = '' |
| michael@0 | 143 | |
| michael@0 | 144 | # Documents to append as an appendix to all manuals. |
| michael@0 | 145 | #latex_appendices = [] |
| michael@0 | 146 | |
| michael@0 | 147 | # If false, no module index is generated. |
| michael@0 | 148 | #latex_use_modindex = True |
