forked from mongodb/docs-bi-connector
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conf.py
195 lines (168 loc) · 7.23 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
# -*- 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 base64
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 giza.config.runtime import RuntimeStateConfig
from giza.config.helper import fetch_config, get_versions, get_manual_path
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',
'fasthtml',
'tabs',
'landing_cards',
'source_constants',
'xmlrole'
]
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)
version = conf.version.branch
release = conf.version.release
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:: https://docs.mongodb.com/bi-connector/',
'.. |bi| replace:: MongoDB Connector for BI',
'.. |bi-short| replace:: BI Connector',
'.. |bi-atlas| replace:: MongoDB Connector for Business Intelligence for MongoDB Atlas',
'.. |bi-atlas-short| replace:: BI Connector for Atlas',
'.. |bi-atlas-short-link| replace:: :doc:`BI Connector for Atlas </atlas-bi-connector>`',
'.. |odbc-driver-name| replace:: MongoDB ODBC driver',
'.. |tls-ssl| replace:: :abbr:`TLS (Transport Layer Security)`/:abbr:`SSL (Secure Sockets Layer)`',
'.. |ssl| replace:: :abbr:`SSL (Secure Sockets Layer)`',
'.. |tls| replace:: :abbr:`TLS (Transport Layer Security)`',
'.. |http| replace:: :abbr:`HTTP (HyperText Transport Protocol)`',
'.. |https| replace:: :abbr:`HTTPS (Secure HyperText Transport Protocol)`',
'.. |cidr| replace:: :abbr:`CIDR (Classless Inter-Domain Routing)`',
'.. |ipaddr| replace:: :abbr:`IP (Internet Protocol)`',
'.. |jira| replace:: `Jira <https://jira.mongodb.org>`__',
'.. |epoch-time| replace:: Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__',
'.. |iso8601-time| replace:: Timestamp in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__ date and time format in |UTC|',
'.. |utc| replace:: :abbr:`UTC (Coordinated Universal Time)`',
'.. |ldap| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)`',
'.. |ldaps| replace:: :abbr:`LDAPS (Secure Lightweight Directory Access Protocol)`',
'.. |kmip| replace:: :abbr:`KMIP (Key Management Interoperability Protocol)`',
'.. |url| replace:: :abbr:`URL (Uniform Resource Locator)`',
'.. |dsn| replace:: :abbr:`DSN (Data Source Name)`',
'.. |odbc| replace:: :abbr:`ODBC (Open Database Connectivity)`',
'.. |jdbc| replace:: :abbr:`JDBC (Java Database Connectivity)`',
'.. |sql| replace:: :abbr:`SQL (Structured Query Language)`',
'.. |kdc| replace:: :abbr:`KDC (Key Distribution Center)`',
'.. |adc| replace:: :abbr:`ADC (Active Directory Controller)`',
'.. |spn| replace:: :abbr:`SPN (Service Principal Name)`',
'.. |upn| replace:: :abbr:`UPN (User Principal Name)`',
'.. |sasl| replace:: :abbr:`SASL (Simple Authentication and Security Layer)`',
'.. |iana| replace:: :abbr:`IANA (Internet Assigned Numbers Authority)`',
'.. |scram| replace:: :abbr:`SCRAM (Salted Challenge Response Authentication Mechanism)`'
])
source_constants = {
'odbc-driver': '`MongoDB ODBC Driver for BI Connector <https://github.com/mongodb/mongo-odbc-driver/releases/>`__',
'bi-atlas-short': 'BI Connector for Atlas',
'bi-short': 'BI Connector',
'download-center': '`MongoDB Download Center <https://www.mongodb.com/download-center/bi-connector>`__',
'download-center-bi': '`MongoDB Connector for BI <https://www.mongodb.com/download-center/bi-connector>`__',
'download-center-tableau': '`MongoDB Connector for BI <https://www.mongodb.com/download-center/bi-connector?jmp=tbl>`__',
'download-center-url': 'https://www.mongodb.com/download-center/bi-connector'
}
extlinks = {
'issue': ('https://jira.mongodb.org/browse/%s', '' ),
'manual': ('http://docs.mongodb.com/manual%s', ''),
'v3.6': ('https://docs.mongodb.com/v3.6%s', ''),
'website': ('https://www.mongodb.com%s?jmp=docs', ''),
}
intersphinx_mapping = {}
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(conf.paths.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_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': "bi-connector",
'repo_name': 'docs-bi-connector',
'jira_project': 'DOCS',
'google_analytics': sconf.theme.google_analytics,
'project': sconf.project,
'epubpath': manual_edition_path.format(conf.project.url,
conf.project.basepath,
'mongodb-bi-connector', 'epub'),
'nav_excluded': sconf.theme.nav_excluded,
'version_selector': get_versions(conf),
'is_upcoming': False,
}
html_sidebars = sconf.sidebars
# -- 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/bi-connector/'
epub_exclude_files = []
epub_pre_files = []
epub_post_files = []