Repository navigation
Expand file tree
/
Copy pathconf.py
More file actions
260 lines (222 loc) · 8.96 KB
/
Copy pathconf.py
File metadata and controls
260 lines (222 loc) · 8.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# -*- coding: utf-8 -*-
#
# MongoDB documentation build configuration file, created by
# sphinx-quickstart on Mon Oct 3 09:58:40 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
import sys
import os
import datetime
from sphinx.errors import SphinxError
from giza.config.runtime import RuntimeStateConfig
from giza.config.helper import fetch_config, get_manual_path
conf = fetch_config(RuntimeStateConfig())
sconf = conf.system.files.data.sphinx_local
sys.path.append(os.path.join(conf.paths.projectroot, conf.paths.buildsystem, 'sphinxext'))
try:
tags
except NameError:
class Tags(object):
def has(self, *args):
return False
tags = Tags()
# -- General configuration ----------------------------------------------------
needs_sphinx = '1.0'
extensions = [
'sphinx.ext.todo',
'sphinx.ext.ifconfig',
'sphinx.ext.extlinks',
'intermanual',
'directives',
'mongodb',
'fasthtml',
'fixed_only',
'tabs',
'icon',
'source_constants',
'xmlrole',
'guides'
]
locale_dirs = [ os.path.join(conf.paths.projectroot, conf.paths.locale) ]
gettext_compact = False
templates_path = ['.templates']
exclude_patterns = []
source_suffix = '.txt'
master_doc = sconf.master_doc
language = 'en'
project = sconf.project
copyright = u'2008-{0}'.format(datetime.date.today().year)
rst_epilog = '\n'.join([
'.. |copy| unicode:: U+000A9',
'.. |ent-build| replace:: MongoDB Enterprise',
'.. |year| replace:: {0}'.format(datetime.date.today().year),
'.. |hardlink| replace:: {0}/{1}'.format(conf.project.url, conf.git.branches.current),
'.. |branch| replace:: ``{0}``'.format(conf.git.branches.current),
'.. |bi| replace:: MongoDB Connector for BI',
'.. |mdbsg| replace:: MongoDB Style Guide'
])
pygments_style = 'sphinx'
extlinks = {
'hardlink' : ( 'http://www.mongodb.com/docs/{0}/%s'.format(conf.git.branches.current), ''),
'issue': ('https://jira.mongodb.org/browse/%s', '' ),
'api': ('https://api.mongodb.com/%s', ''),
'gettingstarted': ('https://www.mongodb.com/docs/getting-started%s', ''),
'manual': ('https://www.mongodb.com/docs/manual%s', ''),
'ecosystem': ('https://www.mongodb.com/docs/ecosystem%s', ''),
'mms-docs': ('https://www.mongodb.com/docs/cloud-manager%s', ''),
'mms-home': ('https://www.mongodb.com/cloud/cloud-manager%s', ''),
'opsmgr': ('https://www.mongodb.com/docs/ops-manager/current%s', ''),
'cldmgr': ('https://www.mongodb.com/docs/cloud-manager/%s', ''),
'atlas': ('https://www.mongodb.com/docs/atlas/%s', ''),
'products': ('https://www.mongodb.com/products%s', ''),
'wtdocs': ('http://source.wiredtiger.com/mongodb-3.4%s', ''),
'v2.2': ('https://www.mongodb.com/docs/v2.2%s', ''),
'v2.4': ('https://www.mongodb.com/docs/v2.4%s', ''),
'v2.6': ('https://www.mongodb.com/docs/v2.6%s', ''),
'v3.0': ('https://www.mongodb.com/docs/v3.0%s', ''),
'v3.2': ('https://www.mongodb.com/docs/v3.2%s', ''),
'v3.4': ('https://www.mongodb.com/docs/v3.4%s', ''),
'v3.6': ('https://www.mongodb.com/docs/v3.6%s', ''),
'v4.0': ('https://www.mongodb.com/docs/v4.0%s', ''),
'bic': ('https://www.mongodb.com/docs/bi-connector/current%s',''),
'k8s': ('https://www.mongodb.com/docs/kubernetes-operator/stable%s',''),
'product': ('http://www.mongodb.com/products/%s?jmp=docs',''),
'website': ('https://www.mongodb.com%s?jmp=docs',''),
'dl': ('http://www.mongodb.com/download-center/%s?jmp=docs',''),
'aws': ('http://docs.aws.amazon.com%s',''),
'driver' : ('https://www.mongodb.com/docs/drivers%s', ''),
'wikipedia' : ('https://en.wikipedia.org/wiki%s', ''),
'mw' : ('https://www.merriam-webster.com/dictionary/%s',''),
'mdbdrivers' : ('https://www.mongodb.com/docs/drivers/%s',''),
'cmos17' : ('https://www.chicagomanualofstyle.org/book/ed17%s',''),
'sphinx-rst' : ('https://www.sphinx-doc.org/en/master/usage/restructuredtext%s', ''),
'sphinx' : ('https://www.sphinx-doc.org/en/master%s', ''),
'rst' : ('http://docutils.sourceforge.net/docs/ref/rst%s',''),
'cc' : ('https://creativecommons.org/licenses%s',''),
'gh' : ('https://github.com%s',''),
'mdb-legal' : ('https://www.mongodb.com/legal%s',''),
'mdbcloud' : ('https://cloud.mongodb.com%s',''),
}
source_constants = {
'rst': 'restructuredText',
'Rst': 'RestructuredText',
'package-branch': 'testing',
'package-version': '4.4.0',
'package-name-org': 'mongodb-org',
'version': '4.0',
}
## add `extlinks` for each published version.
for i in conf.git.branches.published:
extlinks[i] = ( ''.join([ conf.project.url, '/', i, '%s' ]), '' )
intersphinx_mapping = {}
for i in conf.system.files.data.intersphinx:
intersphinx_mapping[i.name] = ( i.url, os.path.join(conf.paths.projectroot,
conf.paths.output,
i.path))
languages = [
("ar", "Arabic"),
("cn", "Chinese"),
("cs", "Czech"),
("de", "German"),
("es", "Spanish"),
("fr", "French"),
("hu", "Hungarian"),
("id", "Indonesian"),
("it", "Italian"),
("jp", "Japanese"),
("ko", "Korean"),
("lt", "Lithuanian"),
("pl", "Polish"),
("pt", "Portuguese"),
("ro", "Romanian"),
("ru", "Russian"),
("tr", "Turkish"),
("uk", "Ukrainian")
]
# -- Options for HTML output ---------------------------------------------------
html_theme = sconf.theme.name
html_theme_path = [ os.path.join(conf.paths.buildsystem, 'themes') ]
html_title = conf.project.title
htmlhelp_basename = 'MongoDBdoc'
html_copy_source = False
html_domain_indices = True
html_use_index = True
html_split_index = False
html_show_sourcelink = False
html_show_sphinx = True
html_show_copyright = True
manual_edition_path = '{0}/{1}/{2}'.format(conf.project.url,
conf.git.branches.current,
sconf.theme.book_path_base)
html_theme_options = {
'branch': conf.git.branches.current,
'pdfpath': manual_edition_path + '-' + conf.git.branches.current + '.pdf',
'epubpath': manual_edition_path + '.epub',
'manual_path': get_manual_path(conf),
'translations': languages,
'language': language,
'repo_name': sconf.theme.repo,
'jira_project': sconf.theme.jira,
'google_analytics': sconf.theme.google_analytics,
'project': sconf.theme.project,
'sitename': sconf.theme.sitename,
'nav_excluded': sconf.theme.nav_excluded,
}
html_sidebars = sconf.sidebars
# -- Options for LaTeX output --------------------------------------------------
latex_documents = []
if 'pdfs' in conf.system.files.data:
for pdf in conf.system.files.data.pdfs:
latex_documents.append((pdf.source, pdf.output, pdf.title, pdf.author, pdf.doc_class))
latex_preamble_elements = [ r'\DeclareUnicodeCharacter{FF04}{\$}',
r'\DeclareUnicodeCharacter{FF0E}{.}',
r'\DeclareUnicodeCharacter{2713}{Y}',
r'\PassOptionsToPackage{hyphens}{url}',
r'\usepackage{upquote}',
r'\pagestyle{plain}',
r'\pagenumbering{arabic}' ]
latex_elements = {
'preamble': '\n'.join(latex_preamble_elements),
'pointsize': '10pt',
'papersize': 'letterpaper',
'tableofcontents': '\\textcopyright{ MongoDB, Inc. 2008 - 2016 } This work is licensed under a \href{http://creativecommons.org/licenses/by-nc-sa/3.0/us/}{Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License}\\clearpage\\tableofcontents'
}
latex_paper_size = 'letter'
latex_use_parts = False
latex_show_pagerefs = True
latex_show_urls = 'footnote'
latex_domain_indices = False
latex_logo = None
latex_appendices = []
# -- Options for manual page output --------------------------------------------
man_pages = []
if 'manpages' in conf.system.files.data:
for mp in conf.system.files.data.manpages:
man_pages.append((mp.file, mp.name, mp.title, mp.authors, mp.section))
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = conf.project.title
epub_author = u'MongoDB, Inc.'
epub_publisher = u'MongoDB, Inc.'
epub_copyright = u'MongoDB, Inc. 2008 - 2016'
epub_theme = 'epub_mongodb'
epub_tocdup = True
epub_tocdepth = 3
epub_language = language
epub_scheme = 'url'
epub_identifier = ''.join([conf.project.url, '/', conf.git.branches.current])
epub_exclude_files = []
epub_pre_files = []
epub_post_files = []
# put it into your conf.py
def setup(app):
# disable versioning for speed
from sphinx.builders.gettext import I18nBuilder
I18nBuilder.versioning_method = 'none'
def doctree_read(app, doctree):
if not isinstance(app.builder, I18nBuilder):
return
from docutils import nodes
from sphinx.versioning import add_uids
list(add_uids(doctree, nodes.TextElement))
app.connect('doctree-read', doctree_read)