Skip to content
Newer
Older
100644 137 lines (99 sloc) 4.1 KB
41f7572 @ianb Added sphinx configuration and the basic layout
ianb authored
1 # -*- coding: utf-8 -*-
2 #
3 # Paste documentation build configuration file, created by
4 # sphinx-quickstart on Tue Apr 22 22:08:49 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('some/directory')
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.ext.*') or your custom ones.
24 extensions = ['sphinx.ext.autodoc']
25
26 # Add any paths that contain templates here, relative to this directory.
4bddc7d @ianb Get Sphinx working
ianb authored
27 ## FIXME: disabled for now because I haven't figured out how to use this:
28 #templates_path = ['_templates']
41f7572 @ianb Added sphinx configuration and the basic layout
ianb authored
29
30 # The suffix of source filenames.
31 source_suffix = '.txt'
32
33 # The master toctree document.
34 master_doc = 'index'
35
36 # General substitutions.
37 project = 'virtualenv'
1607c9b @jezdez Bumped version to 1.7.1 and updated changelog.
jezdez authored
38 copyright = '2007-2012, Ian Bicking, The Open Planning Project, The virtualenv developers'
41f7572 @ianb Added sphinx configuration and the basic layout
ianb authored
39
40 # The default replacements for |version| and |release|, also used in various
41 # other places throughout the built documents.
42 #
43 # The short X.Y version.
e018b07 @ianb Put the version in just one place (virtualenv.py)
ianb authored
44
aa31ec6 @jezdez Bumped version to post1 again.
jezdez authored
45 release = "1.7.1.2.post1"
0359cef @carljm Simplified version handling (we accept redundancy), added news to lon…
carljm authored
46 version = ".".join(release.split(".")[:2])
41f7572 @ianb Added sphinx configuration and the basic layout
ianb authored
47
48 # There are two options for replacing |today|: either, you set today to some
49 # non-false value, then it is used:
50 #today = ''
51 # Else, today_fmt is used as the format for a strftime call.
52 today_fmt = '%B %d, %Y'
53
54 # List of documents that shouldn't be included in the build.
55 unused_docs = []
56
57 # If true, '()' will be appended to :func: etc. cross-reference text.
58 #add_function_parentheses = True
59
60 # If true, the current module name will be prepended to all description
61 # unit titles (such as .. function::).
62 #add_module_names = True
63
64 # If true, sectionauthor and moduleauthor directives will be shown in the
65 # output. They are ignored by default.
66 #show_authors = False
67
68 # The name of the Pygments (syntax highlighting) style to use.
69 pygments_style = 'sphinx'
70
71
72 # Options for HTML output
73 # -----------------------
74
75 # The style sheet to use for HTML and HTML Help pages. A file of that name
76 # must exist either in Sphinx' static/ path, or in one of the custom paths
77 # given in html_static_path.
4bddc7d @ianb Get Sphinx working
ianb authored
78 #html_style = 'default.css'
79
80 html_theme = 'nature'
81 html_theme_path = ['_theme']
41f7572 @ianb Added sphinx configuration and the basic layout
ianb authored
82
83 # Add any paths that contain custom static files (such as style sheets) here,
84 # relative to this directory. They are copied after the builtin static files,
85 # so a file named "default.css" will overwrite the builtin "default.css".
86 html_static_path = ['_static']
87
88 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
89 # using the given strftime format.
90 html_last_updated_fmt = '%b %d, %Y'
91
92 # If true, SmartyPants will be used to convert quotes and dashes to
93 # typographically correct entities.
94 #html_use_smartypants = True
95
96 # Content template for the index page.
97 #html_index = ''
98
99 # Custom sidebar templates, maps document names to template names.
100 #html_sidebars = {}
101
102 # Additional templates that should be rendered to pages, maps page names to
103 # template names.
104 #html_additional_pages = {}
105
106 # If false, no module index is generated.
107 #html_use_modindex = True
108
109 # If true, the reST sources are included in the HTML build as _sources/<name>.
110 #html_copy_source = True
111
112 # Output file base name for HTML help builder.
113 htmlhelp_basename = 'Pastedoc'
114
115
116 # Options for LaTeX output
117 # ------------------------
118
119 # The paper size ('letter' or 'a4').
120 #latex_paper_size = 'letter'
121
122 # The font size ('10pt', '11pt' or '12pt').
123 #latex_font_size = '10pt'
124
125 # Grouping the document tree into LaTeX files. List of tuples
126 # (source start file, target name, title, author, document class [howto/manual]).
127 #latex_documents = []
128
129 # Additional stuff for the LaTeX preamble.
130 #latex_preamble = ''
131
132 # Documents to append as an appendix to all manuals.
133 #latex_appendices = []
134
135 # If false, no module index is generated.
136 #latex_use_modindex = True
Something went wrong with that request. Please try again.