Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 153 lines (110 sloc) 4.892 kb
6b10c22 @thobbs Initial documentation addition.
thobbs authored
1 # -*- coding: utf-8 -*-
2 #
3 # PyMongo documentation build configuration file
4 #
5 # This file is execfile()d with the current directory set to its containing dir.
6
3b397c5 @thobbs With .nojekyll, sphinxtogithub is no longer needed
thobbs authored
7 import sys
8 import os
6b10c22 @thobbs Initial documentation addition.
thobbs authored
9 sys.path.append(os.path.abspath('..'))
10
402d4d1 @thobbs Add __version__ attr to pycassa module, use for setup.py, conf.py
thobbs authored
11 import pycassa
12
6b10c22 @thobbs Initial documentation addition.
thobbs authored
13 # -- General configuration -----------------------------------------------------
14
15 # Add any Sphinx extension module names here, as strings. They can be extensions
16 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3b397c5 @thobbs With .nojekyll, sphinxtogithub is no longer needed
thobbs authored
17 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
6b10c22 @thobbs Initial documentation addition.
thobbs authored
18
19 # Add any paths that contain templates here, relative to this directory.
20 templates_path = ['_templates']
21
22 # The suffix of source filenames.
23 source_suffix = '.rst'
24
25 # The master toctree document.
26 master_doc = 'index'
27
28 # General information about the project.
54a30b9 @thobbs Added sphinxtogithub extension.
thobbs authored
29 project = 'pycassa'
6b10c22 @thobbs Initial documentation addition.
thobbs authored
30
31 # The version info for the project you're documenting, acts as replacement for
32 # |version| and |release|, also used in various other places throughout the
33 # built documents.
34 #
35 # The short X.Y version.
402d4d1 @thobbs Add __version__ attr to pycassa module, use for setup.py, conf.py
thobbs authored
36 version = pycassa.__version__
6b10c22 @thobbs Initial documentation addition.
thobbs authored
37 # The full version, including alpha/beta/rc tags.
402d4d1 @thobbs Add __version__ attr to pycassa module, use for setup.py, conf.py
thobbs authored
38 release = pycassa.__version__
6b10c22 @thobbs Initial documentation addition.
thobbs authored
39
40 # List of documents that shouldn't be included in the build.
41 unused_docs = []
42
43 # List of directories, relative to source directory, that shouldn't be searched
44 # for source files.
45 exclude_trees = ['_build']
46
47 # The reST default role (used for this markup: `text`) to use for all documents.
48 #default_role = None
49
50 # If true, sectionauthor and moduleauthor directives will be shown in the
51 # output. They are ignored by default.
52 #show_authors = False
53
54 # If true, the current module name will be prepended to all description
55 # unit titles (such as .. function::).
56 add_module_names = True
57
58 # The name of the Pygments (syntax highlighting) style to use.
59 pygments_style = 'sphinx'
60
61 # A list of ignored prefixes for module index sorting.
62 #modindex_common_prefix = []
63
64 # -- Options for extensions ----------------------------------------------------
15282bb @thobbs Clean up API documentation in several places
thobbs authored
65 autoclass_content = 'both'
6b10c22 @thobbs Initial documentation addition.
thobbs authored
66
67 # -- Options for HTML output ---------------------------------------------------
68
69 # The theme to use for HTML and HTML Help pages. Major themes that come with
70 # Sphinx are currently 'default' and 'sphinxdoc'.
71 html_theme = 'default'
72
73 # The name for this set of Sphinx documents. If None, it defaults to
74 # "<project> v<release> documentation".
75 #html_title = None
76
77 # A shorter title for the navigation bar. Default is the same as html_title.
78 #html_short_title = None
79
80 # The name of an image file (relative to this directory) to place at the top
81 # of the sidebar.
82 #html_logo = None
83
84 # The name of an image file (within the static path) to use as favicon of the
85 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
86 # pixels large.
43cbf0e @thobbs Add favicon to docs
thobbs authored
87 html_favicon = 'favicon.ico'
6b10c22 @thobbs Initial documentation addition.
thobbs authored
88
89 # Add any paths that contain custom static files (such as style sheets) here,
90 # relative to this directory. They are copied after the builtin static files,
91 # so a file named "default.css" will overwrite the builtin "default.css".
43cbf0e @thobbs Add favicon to docs
thobbs authored
92 html_static_path = ['_static']
6b10c22 @thobbs Initial documentation addition.
thobbs authored
93
94 # Custom sidebar templates, maps document names to template names.
95 #html_sidebars = {}
96
97 # Additional templates that should be rendered to pages, maps page names to
98 # template names.
99 #html_additional_pages = {}
100
101 # If true, links to the reST sources are added to the pages.
102 #html_show_sourcelink = True
103
50d5ef7 @thobbs Remove Copyright notice from bottom of documentation
thobbs authored
104 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
105 html_show_sphinx = True
106
107 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
108 html_show_copyright = False
109
6b10c22 @thobbs Initial documentation addition.
thobbs authored
110 # If true, an OpenSearch description file will be output, and all pages will
111 # contain a <link> tag referring to it. The value of this option must be the
112 # base URL from which the finished HTML is served.
113 #html_use_opensearch = ''
114
115 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
116 #html_file_suffix = ''
117
118 # Output file base name for HTML help builder.
119 htmlhelp_basename = 'pycassa' + release.replace('.', '_')
120
121
122 # -- Options for LaTeX output --------------------------------------------------
123
124 # The paper size ('letter' or 'a4').
125 #latex_paper_size = 'letter'
126
127 # The font size ('10pt', '11pt' or '12pt').
128 #latex_font_size = '10pt'
129
130 # Grouping the document tree into LaTeX files. List of tuples
131 # (source start file, target name, title, author, documentclass [howto/manual]).
132 latex_documents = [
54a30b9 @thobbs Added sphinxtogithub extension.
thobbs authored
133 ('index', 'pycassa.tex', 'pycassa Documentation',
134 'Jonathan Hseu', 'manual'),
6b10c22 @thobbs Initial documentation addition.
thobbs authored
135 ]
136
137 # The name of an image file (relative to this directory) to place at the top of
138 # the title page.
139 #latex_logo = None
140
141 # For "manual" documents, if this is true, then toplevel headings are parts,
142 # not chapters.
143 #latex_use_parts = False
144
145 # Additional stuff for the LaTeX preamble.
146 #latex_preamble = ''
147
148 # Documents to append as an appendix to all manuals.
149 #latex_appendices = []
150
151 # If false, no module index is generated.
152 #latex_use_modindex = True
Something went wrong with that request. Please try again.