forked from mongodb/docs
/
conf.py
216 lines (181 loc) · 7.66 KB
/
conf.py
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
# -*- 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.path
import datetime
project_root = os.path.join(os.path.abspath(os.path.dirname(__file__)))
sys.path.append(project_root)
from bootstrap import buildsystem
sys.path.append(os.path.join(project_root, buildsystem, 'sphinxext'))
sys.path.append(os.path.join(project_root, buildsystem, 'bin'))
from utils import ingest_yaml, ingest_yaml_list
from docs_meta import get_conf, get_versions, get_manual_path
conf = get_conf()
pdfs = ingest_yaml_list(os.path.join(conf.build.paths.builddata, 'pdfs.yaml'))
intersphinx_libs = ingest_yaml_list(os.path.join(conf.build.paths.builddata, 'intersphinx.yaml'))
# -- General configuration ----------------------------------------------------
needs_sphinx = '1.0'
extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.extlinks',
'sphinx.ext.todo',
'mongodb',
'directives',
]
templates_path = ['.templates']
exclude_patterns = []
source_suffix = '.txt'
master_doc = 'contents'
language = 'en'
project = u'mongodb-manual'
copyright = u'2011-' + str(datetime.date.today().year) + ', MongoDB, Inc.'
version = conf.version.branch
release = conf.version.release
rst_epilog = '\n'.join([
'.. |branch| replace:: ``' + conf.git.branches.current + '``',
'.. |copy| unicode:: U+000A9',
'.. |year| replace:: ' + str(datetime.date.today().year),
'.. |ent-build| replace:: MongoDB Enterprise',
'.. |hardlink| replace:: ' + conf.project.url + '/' + conf.git.branches.current
])
pygments_style = 'sphinx'
extlinks = {
'issue': ('https://jira.mongodb.org/browse/%s', '' ),
'wiki': ('http://www.mongodb.org/display/DOCS/%s', ''),
'api': ('http://api.mongodb.org/%s', ''),
'source': ('https://github.com/mongodb/mongo/blob/master/%s', ''),
'docsgithub' : ( 'http://github.com/mongodb/docs/blob/' + conf.git.branches.current + '/%s', ''),
'hardlink' : ( 'http://docs.mongodb.org/' + conf.git.branches.current + '/%s', ''),
'manual': ('http://docs.mongodb.org/manual%s', ''),
'ecosystem': ('http://docs.mongodb.org/ecosystem%s', ''),
'meta-driver': ('http://docs.mongodb.org/meta-driver/latest%s', ''),
'about': ('http://www.mongodb.org/about%s', '')
}
## add `extlinks` for each published version.
for i in conf.git.branches.published:
extlinks[i] = ( conf.project.url + '/' + i + '%s', '')
intersphinx_mapping = {}
for i in intersphinx_libs:
intersphinx_mapping[i['name']] = ( i['url'], os.path.join(conf.build.paths.projectroot,
conf.build.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 = 'manual'
html_theme_path = [ os.path.join(buildsystem, 'themes') ]
html_title = "MongoDB Manual"
htmlhelp_basename = 'MongoDBdoc'
html_logo = ".static/logo-mongodb.png"
html_static_path = ['source/.static']
html_copy_source = False
html_use_smartypants = True
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}/MongoDB-manual'.format(conf.project.url, conf.git.branches.current)
html_theme_options = {
'branch': conf.git.branches.current,
'pdfpath': manual_edition_path + '.pdf',
'epubpath': manual_edition_path + '.epub',
'manual_path': get_manual_path(conf),
'translations': languages,
'language': language,
'repo_name': 'docs',
'jira_project': 'DOCS',
'google_analytics': 'UA-7301842-8',
'project': 'manual',
'version': version,
'version_selector': get_versions(conf),
'stable': conf.version.stable,
}
html_sidebars = {
'**': ['sidebar-nav-manual.html'],
}
html_sidebars['**'].append('formats.html')
html_sidebars['**'].append('intrasite-about.html')
html_sidebars['**'].append('intrasite-ecosystem.html')
# html_sidebars['**'].append('translations.html')
html_sidebars['**'].append('resources.html')
# -- Options for LaTeX output --------------------------------------------------
latex_documents = []
for pdf in pdfs:
_latex_document = ( pdf['source'], pdf['output'], pdf['title'], pdf['author'], pdf['class'])
latex_documents.append( _latex_document )
latex_preamble_elements = [ r'\DeclareUnicodeCharacter{FF04}{\$}',
r'\DeclareUnicodeCharacter{FF0E}{.}',
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'
}
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 = [
# (source start file, name, description, authors, manual section).
('reference/program/bsondump', 'bsondump', u'MongoDB BSON utility', [u'MongoDB Documentation Project'], 1),
('reference/program/mongo', 'mongo', u'MongoDB Shell', [u'MongoDB Documentation Project'], 1),
('reference/program/mongod', 'mongod', u'MongoDB Server', [u'MongoDB Documentation Project'], 1),
('reference/program/mongos', 'mongos', u'MongoDB Shard Utility', [u'MongoDB Documentation Project'], 1),
('reference/program/mongodump', 'mongodump', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongoexport', 'mongoexport', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongofiles', 'mongofiles', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongoimport', 'mongoimport', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongooplog', 'mongooplog', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongorestore', 'mongorestore', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongostat', 'mongostat', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongosniff', 'mongosniff', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongotop', 'mongotop', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/program/mongoperf', 'mongoperf', u'MongoDB', [u'MongoDB Documentation Project'], 1),
('reference/parameters', 'mongodb-parameters', u'MongoDB Parameters', [u'MongoDB Documentation Project'], 5),
]
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'MongoDB Manual'
epub_author = u'MongoDB Documentation Project'
epub_publisher = u'MongoDB, Inc.'
epub_copyright = copyright
epub_theme = 'epub_mongodb'
epub_tocdup = True
epub_tocdepth = 3
epub_language = language
epub_scheme = 'url'
epub_identifier = conf.project.url + '/' + conf.git.branches.current
epub_exclude_files = []
epub_pre_files = []
epub_post_files = []