##// END OF EJS Templates
Added rhodecode to sys.path at Sphinx configuration
Lukasz Balcerzak -
r850:b3ec9f4a beta
parent child Browse files
Show More
@@ -1,223 +1,223 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 #
2 #
3 # RhodeCode documentation build configuration file, created by
3 # RhodeCode documentation build configuration file, created by
4 # sphinx-quickstart on Sun Oct 10 16:46:37 2010.
4 # sphinx-quickstart on Sun Oct 10 16:46:37 2010.
5 #
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
7 #
8 # Note that not all possible configuration values are present in this
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
9 # autogenerated file.
10 #
10 #
11 # All configuration values have a default; values that are commented out
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
12 # serve to show the default.
13
13
14 import sys, os
14 import sys, os
15
15
16 # If extensions (or modules to document with autodoc) are in another directory,
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
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.
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.insert(0, os.path.abspath('.'))
19 sys.path.insert(0, os.path.abspath('..'))
20
20
21 # -- General configuration -----------------------------------------------------
21 # -- General configuration -----------------------------------------------------
22
22
23 # If your documentation needs a minimal Sphinx version, state it here.
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
24 #needs_sphinx = '1.0'
25
25
26 # Add any Sphinx extension module names here, as strings. They can be extensions
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
29
29
30 # Add any paths that contain templates here, relative to this directory.
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
31 templates_path = ['_templates']
32
32
33 # The suffix of source filenames.
33 # The suffix of source filenames.
34 source_suffix = '.rst'
34 source_suffix = '.rst'
35
35
36 # The encoding of source files.
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
37 #source_encoding = 'utf-8-sig'
38
38
39 # The master toctree document.
39 # The master toctree document.
40 master_doc = 'index'
40 master_doc = 'index'
41
41
42 # General information about the project.
42 # General information about the project.
43 project = u'RhodeCode'
43 project = u'RhodeCode'
44 copyright = u'2010, Marcin Kuzminski'
44 copyright = u'2010, Marcin Kuzminski'
45
45
46 # The version info for the project you're documenting, acts as replacement for
46 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the
47 # |version| and |release|, also used in various other places throughout the
48 # built documents.
48 # built documents.
49 #
49 #
50 # The short X.Y version.
50 # The short X.Y version.
51 root = os.path.dirname(os.path.dirname(__file__))
51 root = os.path.dirname(os.path.dirname(__file__))
52 sys.path.append(root)
52 sys.path.append(root)
53 from rhodecode import get_version, __version__
53 from rhodecode import get_version, __version__
54 version = get_version()
54 version = get_version()
55 # The full version, including alpha/beta/rc tags.
55 # The full version, including alpha/beta/rc tags.
56 release = __version__
56 release = __version__
57
57
58 # The language for content autogenerated by Sphinx. Refer to documentation
58 # The language for content autogenerated by Sphinx. Refer to documentation
59 # for a list of supported languages.
59 # for a list of supported languages.
60 #language = None
60 #language = None
61
61
62 # There are two options for replacing |today|: either, you set today to some
62 # There are two options for replacing |today|: either, you set today to some
63 # non-false value, then it is used:
63 # non-false value, then it is used:
64 #today = ''
64 #today = ''
65 # Else, today_fmt is used as the format for a strftime call.
65 # Else, today_fmt is used as the format for a strftime call.
66 #today_fmt = '%B %d, %Y'
66 #today_fmt = '%B %d, %Y'
67
67
68 # List of patterns, relative to source directory, that match files and
68 # List of patterns, relative to source directory, that match files and
69 # directories to ignore when looking for source files.
69 # directories to ignore when looking for source files.
70 exclude_patterns = ['_build']
70 exclude_patterns = ['_build']
71
71
72 # The reST default role (used for this markup: `text`) to use for all documents.
72 # The reST default role (used for this markup: `text`) to use for all documents.
73 #default_role = None
73 #default_role = None
74
74
75 # If true, '()' will be appended to :func: etc. cross-reference text.
75 # If true, '()' will be appended to :func: etc. cross-reference text.
76 #add_function_parentheses = True
76 #add_function_parentheses = True
77
77
78 # If true, the current module name will be prepended to all description
78 # If true, the current module name will be prepended to all description
79 # unit titles (such as .. function::).
79 # unit titles (such as .. function::).
80 #add_module_names = True
80 #add_module_names = True
81
81
82 # If true, sectionauthor and moduleauthor directives will be shown in the
82 # If true, sectionauthor and moduleauthor directives will be shown in the
83 # output. They are ignored by default.
83 # output. They are ignored by default.
84 #show_authors = False
84 #show_authors = False
85
85
86 # The name of the Pygments (syntax highlighting) style to use.
86 # The name of the Pygments (syntax highlighting) style to use.
87 pygments_style = 'sphinx'
87 pygments_style = 'sphinx'
88
88
89 # A list of ignored prefixes for module index sorting.
89 # A list of ignored prefixes for module index sorting.
90 #modindex_common_prefix = []
90 #modindex_common_prefix = []
91
91
92
92
93 # -- Options for HTML output ---------------------------------------------------
93 # -- Options for HTML output ---------------------------------------------------
94
94
95 # The theme to use for HTML and HTML Help pages. See the documentation for
95 # The theme to use for HTML and HTML Help pages. See the documentation for
96 # a list of builtin themes.
96 # a list of builtin themes.
97 html_theme = 'nature'
97 html_theme = 'nature'
98
98
99 # Theme options are theme-specific and customize the look and feel of a theme
99 # Theme options are theme-specific and customize the look and feel of a theme
100 # further. For a list of options available for each theme, see the
100 # further. For a list of options available for each theme, see the
101 # documentation.
101 # documentation.
102 #html_theme_options = {}
102 #html_theme_options = {}
103
103
104 # Add any paths that contain custom themes here, relative to this directory.
104 # Add any paths that contain custom themes here, relative to this directory.
105 html_theme_path = ['theme']
105 html_theme_path = ['theme']
106
106
107 # The name for this set of Sphinx documents. If None, it defaults to
107 # The name for this set of Sphinx documents. If None, it defaults to
108 # "<project> v<release> documentation".
108 # "<project> v<release> documentation".
109 #html_title = None
109 #html_title = None
110
110
111 # A shorter title for the navigation bar. Default is the same as html_title.
111 # A shorter title for the navigation bar. Default is the same as html_title.
112 #html_short_title = None
112 #html_short_title = None
113
113
114 # The name of an image file (relative to this directory) to place at the top
114 # The name of an image file (relative to this directory) to place at the top
115 # of the sidebar.
115 # of the sidebar.
116 #html_logo = None
116 #html_logo = None
117
117
118 # The name of an image file (within the static path) to use as favicon of the
118 # The name of an image file (within the static path) to use as favicon of the
119 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
119 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
120 # pixels large.
120 # pixels large.
121 #html_favicon = None
121 #html_favicon = None
122
122
123 # Add any paths that contain custom static files (such as style sheets) here,
123 # Add any paths that contain custom static files (such as style sheets) here,
124 # relative to this directory. They are copied after the builtin static files,
124 # relative to this directory. They are copied after the builtin static files,
125 # so a file named "default.css" will overwrite the builtin "default.css".
125 # so a file named "default.css" will overwrite the builtin "default.css".
126 #html_static_path = ['_static']
126 #html_static_path = ['_static']
127
127
128 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129 # using the given strftime format.
129 # using the given strftime format.
130 #html_last_updated_fmt = '%b %d, %Y'
130 #html_last_updated_fmt = '%b %d, %Y'
131
131
132 # If true, SmartyPants will be used to convert quotes and dashes to
132 # If true, SmartyPants will be used to convert quotes and dashes to
133 # typographically correct entities.
133 # typographically correct entities.
134 #html_use_smartypants = True
134 #html_use_smartypants = True
135
135
136 # Custom sidebar templates, maps document names to template names.
136 # Custom sidebar templates, maps document names to template names.
137 #html_sidebars = {}
137 #html_sidebars = {}
138
138
139 # Additional templates that should be rendered to pages, maps page names to
139 # Additional templates that should be rendered to pages, maps page names to
140 # template names.
140 # template names.
141 #html_additional_pages = {}
141 #html_additional_pages = {}
142
142
143 # If false, no module index is generated.
143 # If false, no module index is generated.
144 #html_domain_indices = True
144 #html_domain_indices = True
145
145
146 # If false, no index is generated.
146 # If false, no index is generated.
147 #html_use_index = True
147 #html_use_index = True
148
148
149 # If true, the index is split into individual pages for each letter.
149 # If true, the index is split into individual pages for each letter.
150 #html_split_index = False
150 #html_split_index = False
151
151
152 # If true, links to the reST sources are added to the pages.
152 # If true, links to the reST sources are added to the pages.
153 #html_show_sourcelink = True
153 #html_show_sourcelink = True
154
154
155 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
156 #html_show_sphinx = True
156 #html_show_sphinx = True
157
157
158 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
159 #html_show_copyright = True
159 #html_show_copyright = True
160
160
161 # If true, an OpenSearch description file will be output, and all pages will
161 # If true, an OpenSearch description file will be output, and all pages will
162 # contain a <link> tag referring to it. The value of this option must be the
162 # contain a <link> tag referring to it. The value of this option must be the
163 # base URL from which the finished HTML is served.
163 # base URL from which the finished HTML is served.
164 #html_use_opensearch = ''
164 #html_use_opensearch = ''
165
165
166 # This is the file name suffix for HTML files (e.g. ".xhtml").
166 # This is the file name suffix for HTML files (e.g. ".xhtml").
167 #html_file_suffix = None
167 #html_file_suffix = None
168
168
169 # Output file base name for HTML help builder.
169 # Output file base name for HTML help builder.
170 htmlhelp_basename = 'RhodeCodedoc'
170 htmlhelp_basename = 'RhodeCodedoc'
171
171
172
172
173 # -- Options for LaTeX output --------------------------------------------------
173 # -- Options for LaTeX output --------------------------------------------------
174
174
175 # The paper size ('letter' or 'a4').
175 # The paper size ('letter' or 'a4').
176 #latex_paper_size = 'letter'
176 #latex_paper_size = 'letter'
177
177
178 # The font size ('10pt', '11pt' or '12pt').
178 # The font size ('10pt', '11pt' or '12pt').
179 #latex_font_size = '10pt'
179 #latex_font_size = '10pt'
180
180
181 # Grouping the document tree into LaTeX files. List of tuples
181 # Grouping the document tree into LaTeX files. List of tuples
182 # (source start file, target name, title, author, documentclass [howto/manual]).
182 # (source start file, target name, title, author, documentclass [howto/manual]).
183 latex_documents = [
183 latex_documents = [
184 ('index', 'RhodeCode.tex', u'RhodeCode Documentation',
184 ('index', 'RhodeCode.tex', u'RhodeCode Documentation',
185 u'Marcin Kuzminski', 'manual'),
185 u'Marcin Kuzminski', 'manual'),
186 ]
186 ]
187
187
188 # The name of an image file (relative to this directory) to place at the top of
188 # The name of an image file (relative to this directory) to place at the top of
189 # the title page.
189 # the title page.
190 #latex_logo = None
190 #latex_logo = None
191
191
192 # For "manual" documents, if this is true, then toplevel headings are parts,
192 # For "manual" documents, if this is true, then toplevel headings are parts,
193 # not chapters.
193 # not chapters.
194 #latex_use_parts = False
194 #latex_use_parts = False
195
195
196 # If true, show page references after internal links.
196 # If true, show page references after internal links.
197 #latex_show_pagerefs = False
197 #latex_show_pagerefs = False
198
198
199 # If true, show URL addresses after external links.
199 # If true, show URL addresses after external links.
200 #latex_show_urls = False
200 #latex_show_urls = False
201
201
202 # Additional stuff for the LaTeX preamble.
202 # Additional stuff for the LaTeX preamble.
203 #latex_preamble = ''
203 #latex_preamble = ''
204
204
205 # Documents to append as an appendix to all manuals.
205 # Documents to append as an appendix to all manuals.
206 #latex_appendices = []
206 #latex_appendices = []
207
207
208 # If false, no module index is generated.
208 # If false, no module index is generated.
209 #latex_domain_indices = True
209 #latex_domain_indices = True
210
210
211
211
212 # -- Options for manual page output --------------------------------------------
212 # -- Options for manual page output --------------------------------------------
213
213
214 # One entry per manual page. List of tuples
214 # One entry per manual page. List of tuples
215 # (source start file, name, description, authors, manual section).
215 # (source start file, name, description, authors, manual section).
216 man_pages = [
216 man_pages = [
217 ('index', 'rhodecode', u'RhodeCode Documentation',
217 ('index', 'rhodecode', u'RhodeCode Documentation',
218 [u'Marcin Kuzminski'], 1)
218 [u'Marcin Kuzminski'], 1)
219 ]
219 ]
220
220
221
221
222 # Example configuration for intersphinx: refer to the Python standard library.
222 # Example configuration for intersphinx: refer to the Python standard library.
223 intersphinx_mapping = {'http://docs.python.org/': None}
223 intersphinx_mapping = {'http://docs.python.org/': None}
General Comments 0
You need to be logged in to leave comments. Login now