##// END OF EJS Templates
docs: python3 fixes
super-admin -
r5051:9efc5b29 default
parent child Browse files
Show More
@@ -1,311 +1,311 b''
1 # -*- coding: utf-8 -*-
1
2 2 #
3 3 # RhodeCode Enterprise documentation build configuration file, created by
4 4 # sphinx-quickstart on Tue Nov 4 11:48:37 2014.
5 5 #
6 6 # This file is execfile()d with the current directory set to its
7 7 # containing dir.
8 8 #
9 9 # Note that not all possible configuration values are present in this
10 10 # autogenerated file.
11 11 #
12 12 # All configuration values have a default; values that are commented out
13 13 # serve to show the default.
14 14
15 15 import sys
16 16 import os
17 17 import datetime
18 18 import sphinx_rtd_theme
19 19
20 20 # If extensions (or modules to document with autodoc) are in another directory,
21 21 # add these directories to sys.path here. If the directory is relative to the
22 22 # documentation root, use os.path.abspath to make it absolute, like shown here.
23 23 sys.path.insert(0, os.path.abspath('.'))
24 24 import common
25 25
26 26 # -- General configuration ------------------------------------------------
27 27
28 28 # If your documentation needs a minimal Sphinx version, state it here.
29 29 #needs_sphinx = '1.0'
30 30
31 31 # Add any Sphinx extension module names here, as strings. They can be
32 32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 33 # ones.
34 34 extensions = [
35 35 'sphinx.ext.autodoc',
36 36 'sphinx.ext.intersphinx',
37 37 'sphinx.ext.todo',
38 38 'sphinx.ext.imgmath'
39 39 ]
40 40
41 41 intersphinx_mapping = {
42 42 'enterprise': ('https://docs.rhodecode.com/RhodeCode-Enterprise/', None),
43 43 'control': ('https://docs.rhodecode.com/RhodeCode-Control/', None),
44 44 }
45 45
46 46 # Add any paths that contain templates here, relative to this directory.
47 47 templates_path = ['_templates']
48 48
49 49 # The suffix of source filenames.
50 50 source_suffix = '.rst'
51 51
52 52 # The encoding of source files.
53 53 #source_encoding = 'utf-8-sig'
54 54
55 55 # The master toctree document.
56 56 master_doc = 'index'
57 57
58 58 # The version info for the project you're documenting, acts as replacement for
59 59 # |version| and |release|, also used in various other places throughout the
60 60 # built documents.
61 61
62 62
63 63 def _get_version():
64 64 with open('../rhodecode/VERSION') as f:
65 65 return f.read().strip()
66 66
67 67
68 68 # The full version, including alpha/beta/rc tags.
69 69 release = _get_version()
70 70 # The short X.Y version.
71 71 version = '.'.join(release.split('.', 2)[:2]) # First two parts of release
72 72
73 73 # General information about the project.
74 74 project = u'RhodeCode Enterprise %s ' % _get_version()
75 75 copyright = u'2010-{now.year}, RhodeCode GmbH'.format(
76 76 now=datetime.datetime.today())
77 77
78 78
79 79 # The language for content autogenerated by Sphinx. Refer to documentation
80 80 # for a list of supported languages.
81 81 #language = None
82 82
83 83 rst_epilog = common.rst_epilog + """
84 84 .. |async| replace:: asynchronous
85 85 """
86 86
87 87 # There are two options for replacing |today|: either, you set today to some
88 88 # non-false value, then it is used:
89 89 #today = ''
90 90 # Else, today_fmt is used as the format for a strftime call.
91 91 #today_fmt = '%B %d, %Y'
92 92
93 93 # List of patterns, relative to source directory, that match files and
94 94 # directories to ignore when looking for source files.
95 95 exclude_patterns = [
96 96 # Special directories
97 97 '_build',
98 98 'result',
99 99
100 100 # Other RST files
101 101 'admin/rhodecode-backup.rst',
102 102 'issue-trackers/redmine.rst',
103 103 'known-issues/error-msg-guide.rst',
104 104 'tutorials/docs-build.rst',
105 105 'integrations/example-ext.py',
106 106 'collaboration/supported-workflows.rst',
107 107 ]
108 108
109 109
110 110 # The reST default role (used for this markup: `text`) to use for all
111 111 # documents.
112 112 #default_role = None
113 113
114 114 # If true, '()' will be appended to :func: etc. cross-reference text.
115 115 #add_function_parentheses = True
116 116
117 117 # If true, the current module name will be prepended to all description
118 118 # unit titles (such as .. function::).
119 119 #add_module_names = True
120 120
121 121 # If true, sectionauthor and moduleauthor directives will be shown in the
122 122 # output. They are ignored by default.
123 123 #show_authors = False
124 124
125 125 # The name of the Pygments (syntax highlighting) style to use.
126 126 pygments_style = 'sphinx'
127 127
128 128 # A list of ignored prefixes for module index sorting.
129 129 #modindex_common_prefix = []
130 130
131 131 # If true, keep warnings as "system message" paragraphs in the built documents.
132 132 keep_warnings = tags.has("dev")
133 133
134 134
135 135 # -- Options for HTML output ----------------------------------------------
136 136
137 137 # The theme to use for HTML and HTML Help pages. See the documentation for
138 138 # a list of builtin themes.
139 139 #html_theme = 'rctheme'
140 140 html_theme = 'sphinx_rtd_theme'
141 141
142 142 # Theme options are theme-specific and customize the look and feel of a theme
143 143 # further. For a list of options available for each theme, see the
144 144 # documentation.
145 145 #html_theme_options = {}
146 146 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
147 147
148 148 # Add any paths that contain custom themes here, relative to this directory.
149 149 #html_theme_path = []
150 150
151 151 # The name for this set of Sphinx documents. If None, it defaults to
152 152 # "<project> v<release> documentation".
153 153 #html_title = None
154 154
155 155 # A shorter title for the navigation bar. Default is the same as html_title.
156 156 #html_short_title = None
157 157
158 158 # The name of an image file (relative to this directory) to place at the top
159 159 # of the sidebar.
160 160 #html_logo = None
161 161 html_sidebars = {
162 162 '**': ['globaltoc.html'],
163 163 }
164 164
165 165 # The name of an image file (within the static path) to use as favicon of the
166 166 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
167 167 # pixels large.
168 168 html_favicon = 'images/favicon.ico'
169 169
170 170 # Add any paths that contain custom static files (such as style sheets) here,
171 171 # relative to this directory. They are copied after the builtin static files,
172 172 # so a file named "default.css" will overwrite the builtin "default.css".
173 173 html_static_path = ['static/css/add.css']
174 174
175 175 # Add any extra paths that contain custom files (such as robots.txt or
176 176 # .htaccess) here, relative to this directory. These files are copied
177 177 # directly to the root of the documentation.
178 178 #html_extra_path = []
179 179
180 180 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
181 181 # using the given strftime format.
182 182 #html_last_updated_fmt = '%b %d, %Y'
183 183
184 184 # If true, SmartyPants will be used to convert quotes and dashes to
185 185 # typographically correct entities.
186 186 #html_use_smartypants = True
187 187
188 188 # Custom sidebar templates, maps document names to template names.
189 189 #html_sidebars = {}
190 190
191 191 # Additional templates that should be rendered to pages, maps page names to
192 192 # template names.
193 193 #html_additional_pages = {}
194 194
195 195 # If false, no module index is generated.
196 196 #html_domain_indices = True
197 197
198 198 # If false, no index is generated.
199 199 #html_use_index = True
200 200
201 201 # If true, the index is split into individual pages for each letter.
202 202 #html_split_index = False
203 203
204 204 # If true, links to the reST sources are added to the pages.
205 205 #html_show_sourcelink = True
206 206
207 207 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
208 208 #html_show_sphinx = True
209 209
210 210 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
211 211 #html_show_copyright = True
212 212
213 213 # If true, an OpenSearch description file will be output, and all pages will
214 214 # contain a <link> tag referring to it. The value of this option must be the
215 215 # base URL from which the finished HTML is served.
216 216 #html_use_opensearch = ''
217 217
218 218 # This is the file name suffix for HTML files (e.g. ".xhtml").
219 219 #html_file_suffix = None
220 220
221 221 # Output file base name for HTML help builder.
222 222 htmlhelp_basename = 'rhodecode-enterprise'
223 223
224 224
225 225 # -- Options for LaTeX output ---------------------------------------------
226 226
227 227 latex_elements = {
228 228 'classoptions': ',oneside',
229 229 'babel': '\\usepackage[english]{babel}',
230 230
231 231 # The paper size ('letterpaper' or 'a4paper').
232 232 #'papersize': 'letterpaper',
233 233
234 234 # The font size ('10pt', '11pt' or '12pt').
235 235 #'pointsize': '10pt',
236 236
237 237 # Additional stuff for the LaTeX preamble.
238 238 #'preamble': '',
239 239 }
240 240
241 241 # Grouping the document tree into LaTeX files. List of tuples
242 242 # (source start file, target name, title,
243 243 # author, documentclass [howto, manual, or own class]).
244 244 latex_documents = [
245 245 ('index', 'RhodeCodeEnterprise.tex', u'RhodeCode Enterprise',
246 246 u'RhodeCode GmbH', 'manual'),
247 247 ]
248 248
249 249 # The name of an image file (relative to this directory) to place at the top of
250 250 # the title page.
251 251 #latex_logo = None
252 252
253 253 # For "manual" documents, if this is true, then toplevel headings are parts,
254 254 # not chapters.
255 255 #latex_use_parts = False
256 256
257 257 # If true, show page references after internal links.
258 258 latex_show_pagerefs = True
259 259
260 260 # If true, show URL addresses after external links.
261 261 latex_show_urls = 'footnote'
262 262
263 263 # Documents to append as an appendix to all manuals.
264 264 #latex_appendices = []
265 265
266 266 # If false, no module index is generated.
267 267 #latex_domain_indices = True
268 268
269 269 # Mode for literal blocks wider than the frame. Can be
270 270 # overflow, shrink or truncate
271 271 pdf_fit_mode = "truncate"
272 272
273 273
274 274 # -- Options for manual page output ---------------------------------------
275 275
276 276 # One entry per manual page. List of tuples
277 277 # (source start file, name, description, authors, manual section).
278 278 man_pages = [
279 279 ('index', 'rhodecodeenterprise', u'RhodeCode Enterprise',
280 280 [u'RhodeCode GmbH'], 1)
281 281 ]
282 282
283 283 # If true, show URL addresses after external links.
284 284 #man_show_urls = False
285 285
286 286
287 287 # -- Options for Texinfo output -------------------------------------------
288 288
289 289 # Grouping the document tree into Texinfo files. List of tuples
290 290 # (source start file, target name, title, author,
291 291 # dir menu entry, description, category)
292 292 texinfo_documents = [
293 293 ('index', 'RhodeCodeEnterprise', u'RhodeCode Enterprise',
294 294 u'RhodeCode Docs Team', 'RhodeCodeEnterprise', 'RhodeCode Docs Project',
295 295 'Miscellaneous'),
296 296 ]
297 297
298 298 # Documents to append as an appendix to all manuals.
299 299 #texinfo_appendices = []
300 300
301 301 # If false, no module index is generated.
302 302 #texinfo_domain_indices = True
303 303
304 304 # How to display URL addresses: 'footnote', 'no', or 'inline'.
305 305 #texinfo_show_urls = 'footnote'
306 306
307 307 # If true, do not generate a @detailmenu in the "Top" node's menu.
308 308 #texinfo_no_detailmenu = False
309 309
310 310 # We want to see todo notes in case of a pre-release build of the documentation
311 311 todo_include_todos = tags.has("dev")
@@ -1,8 +1,7 b''
1 1 sphinx==1.8.2
2 2 six==1.11.0
3 3 sphinx_rtd_theme==0.4.1
4 4 docutils==0.16.0
5 5 pygments==2.3.0
6 6 markupsafe==1.0.0
7 7 jinja2==2.9.6
8 pytz==2023.3
General Comments 0
You need to be logged in to leave comments. Login now