forked from mongodb/docs-ecosystem
/
conf.py
207 lines (172 loc) · 6.68 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
# -*- 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
try:
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), buildsystem, 'sphinxext')))
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), buildsystem, 'bin')))
from utils.serialization import ingest_yaml, ingest_yaml_list
from utils.structures import BuildConfiguration
from utils.config import get_conf
from utils.project import get_versions, get_manual_path
conf = get_conf()
pdfs = ingest_yaml_list(os.path.join(conf.paths.projectroot, conf.paths.builddata, 'pdfs.yaml'))
sconf = BuildConfiguration(os.path.join(conf.paths.projectroot, conf.paths.builddata, 'sphinx_local.yaml'))
intersphinx_libs = ingest_yaml_list(os.path.join(conf.paths.projectroot, conf.paths.builddata, 'intersphinx.yaml'))
except:
from giza.config.runtime import RuntimeStateConfig
from giza.config.helper import fetch_config, get_versions, get_manual_path
from giza.tools.strings import dot_concat
conf = fetch_config(RuntimeStateConfig())
intersphinx_libs = conf.system.files.data.intersphinx
pdfs = conf.system.files.data.pdfs
sconf = conf.system.files.data.sphinx_local
sys.path.append(os.path.join(conf.paths.projectroot, conf.paths.buildsystem, 'sphinxext'))
# -- General configuration ----------------------------------------------------
needs_sphinx = '1.0'
extensions = [
'sphinx.ext.extlinks',
'sphinx.ext.todo',
'mongodb',
'directives',
'intermanual'
]
templates_path = ['.templates']
exclude_patterns = []
source_suffix = '.txt'
master_doc = sconf.master_doc
language = 'en'
project = sconf.project
copyright = u'2011-{0}'.format(datetime.date.today().year)
version = '2.6.0'
release = version
rst_epilog = '\n'.join([
'.. |branch| replace:: ``{0}``'.format(conf.git.branches.current),
'.. |copy| unicode:: U+000A9',
'.. |year| replace:: {0}'.format(datetime.date.today().year),
'.. |ent-build| replace:: MongoDB Enterprise',
'.. |hardlink| replace:: http://docs.mongodb.org/ecosystem/'
])
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', '')
}
intersphinx_mapping = {}
try:
for i in intersphinx_libs:
intersphinx_mapping[i['name']] = ( i['url'], os.path.join(conf.paths.projectroot,
conf.paths.output,
i['path']))
except:
for i in intersphinx_libs:
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(buildsystem, 'themes') ]
html_title = conf.project.title
htmlhelp_basename = 'MongoDBdoc'
html_logo = ".static/logo-mongodb.png"
html_static_path = ['source/.static']
html_last_updated_fmt = '%b %d, %Y'
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}/{2}.{3}'
html_theme_options = {
'branch': conf.git.branches.current,
'translations': languages,
'language': language,
'manual_path': "ecosystem",
'repo_name': 'docs-ecosystem',
'jira_project': 'DOCS',
'google_analytics': sconf.theme.google_analytics,
'project': sconf.project,
'epubpath': manual_edition_path.format(conf.project.url,
conf.project.basepath,
'mongodb-ecosystem', 'epub'),
'pdfpath': manual_edition_path.format(conf.project.url,
conf.project.basepath,
'MongoDB-Ecosystem-guide', 'pdf'),
'nav_excluded': sconf.theme.nav_excluded,
}
html_sidebars = sconf.sidebars
# -- Options for LaTeX output --------------------------------------------------
latex_documents = []
try:
for pdf in pdfs:
_latex_document = ( pdf['source'], pdf['output'], pdf['title'], pdf['author'], pdf['class'])
latex_documents.append( _latex_document )
except:
for pdf in pdfs:
_latex_document = (pdf.source, pdf.output, pdf.title, pdf.author, pdf.doc_class)
latex_documents.append( _latex_document )
latex_elements = {
'preamble': '\DeclareUnicodeCharacter{FF04}{\$} \DeclareUnicodeCharacter{FF0E}{.} \PassOptionsToPackage{hyphens}{url}',
'pointsize': '10pt',
'papersize': 'letterpaper'
}
latex_paper_size = 'letter'
latex_use_parts = True
latex_show_pagerefs = True
latex_show_urls = False
latex_domain_indices = True
latex_logo = None
latex_appendices = []
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = conf.project.title
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 = 'en'
epub_scheme = 'url'
epub_identifier = 'http://docs.mongodb.org/ecosystem/'
epub_exclude_files = []
epub_pre_files = []
epub_post_files = []