forked from openedx/edx-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conf.py
195 lines (158 loc) · 6.65 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
# Shared configuration for edX docs.
import datetime
import os
import sys
import urllib
import edx_theme
# on_rtd is whether we are on readthedocs.io, this line of code grabbed from docs.readthedocs.io
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# OK, this is gross: I don't know of a way to find out what builder is running,
# so let's examine the command line, and take the word after -b.
the_builder = sys.argv[sys.argv.index("-b") + 1]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
master_doc = 'index'
# The suffix of source filenames.
source_suffix = '.rst'
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'edx_theme',
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.extlinks',
'sphinx.ext.graphviz'
]
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
html_context = {}
if on_rtd:
html_context["on_rtd"] = on_rtd
html_context["google_analytics_id"] = ''
html_context["disqus_shortname"] = 'edx'
html_context["github_base_account"] = 'edx'
html_context["github_project"] = 'edx-documentation'
html_theme = 'edx_theme'
html_theme_path = [edx_theme.get_html_theme_path()]
html_theme_options = {}
html_theme_options['navigation_depth'] = 3
html_favicon = os.path.join(edx_theme.get_html_theme_path(), 'edx_theme', 'static', 'css', 'favicon.ico')
# Help and Feedback links. These are customized for the category and audience
# of the book. Add a line to the book's conf.py like this:
#
# set_audience(PARTNER, COURSE_TEAMS)
#
# Categories
PARTNER = object()
OPENEDX = object()
# Audiences
COURSE_TEAMS = object()
LEARNERS = object()
RESEARCHERS = object()
DEVELOPERS = object()
HELP_LINKS = {
(PARTNER, COURSE_TEAMS): {
'help_url': None, #"https://partners.edx.org/forums/partner-forums",
'help_link_text': None,
},
(PARTNER, LEARNERS): {
'help_url': "https://support.edx.org",
'help_link_text': "Contact Support",
},
(PARTNER, RESEARCHERS): {
'help_url': "http://edx.readthedocs.io/projects/devdata/en/latest/front_matter/preface.html#resources-for-researchers",
'help_link_text': "Get Help",
},
(PARTNER, DEVELOPERS): {
'help_url': "https://open.edx.org/getting-help",
'help_link_text': "Get Help",
},
(OPENEDX, LEARNERS): {
'help_url': None,
'help_link_text': None,
},
(OPENEDX, COURSE_TEAMS): {
'help_url': "https://open.edx.org/getting-help",
'help_link_text': "Get Help",
},
(OPENEDX, DEVELOPERS): {
'help_url': "https://open.edx.org/getting-help",
'help_link_text': "Get Help",
},
}
# Defaults for the help links.
html_context.update({
'help_url': None,
'help_link_text': None,
'feedback_form_link_text': "Give Doc Feedback",
})
def set_audience(category, audience):
"""Used from specific conf.py files to set the audience for a book."""
help_data = HELP_LINKS.get((category, audience))
if help_data:
html_context.update(help_data)
FEEDBACK_FORM_FMT = "https://docs.google.com/forms/d/1T5QGnYb_QnQoMO7T_eatq02miPTY40WVe3cgGphNAdY/viewform?entry.1952574704&entry.241692674={pageid}"
def feedback_form_url(project, page):
"""Create a URL for feedback on a particular page in a project."""
return FEEDBACK_FORM_FMT.format(pageid=urllib.quote("{}: {}".format(project, page)))
# We want the feedback_form_url function available in HTML templates, but it
# makes html_context un-JSON-able, so don't add it if we are doing JSON.
if the_builder != "json":
html_context['feedback_form_url'] = feedback_form_url
# General information about the project.
copyright = '{year}, edX Inc.'.format(year=datetime.datetime.now().year)
# Intersphinx manages the connections between books.
# Normally the references in a book are downloaded from readthedocs. But you
# can also provide a local file to look in. It's easier to fix broken
# references betweeen books if you can do a local build and use the local
# reference files. These helper functions are for both reducing the repetition
# in the mapping dictionary, and for optionally specifying a local file to look
# in if it exists.
#
# We often use the same directory to build two books (edX vs Open edX). In
# those cases, only use ism_location for one book, not both, or we'll be
# looking for A's references in an index built for B.
def edx_rtd_url(slug):
"""Use this with the readthedoc project slug to create the full URL."""
return f"https://edx.readthedocs.io/projects/{slug}/en/latest/"
def ism_location(dir_name):
"""Calculate the intersphinx_mapping location to use for a book.
`dir_name` is the directory name under edx-documentation/en_us for the book.
"""
objects_inv = f"../../{dir_name}/build/html/objects.inv"
if os.path.exists(objects_inv):
return (objects_inv, None)
else:
return None
intersphinx_mapping = {
"opencoursestaff" : (edx_rtd_url("open-edx-building-and-running-a-course"), None),
"data" : (edx_rtd_url("devdata"), ism_location("data")),
"partnercoursestaff": (edx_rtd_url("edx-partner-course-staff"), ism_location("course_authors")),
"insights" : (edx_rtd_url("edx-insights"), None),
"xblockapi" : (edx_rtd_url("xblock"), None),
"xblocktutorial" : (edx_rtd_url("xblock-tutorial"), ism_location("xblock-tutorial")),
"installation" : (edx_rtd_url("edx-installing-configuring-and-running"), ism_location("install_operations")),
"olx" : (edx_rtd_url("edx-open-learning-xml"), ism_location("olx")),
"learners" : (edx_rtd_url("edx-guide-for-students"), None),
"openlearners" : (edx_rtd_url("open-edx-learner-guide"), None),
"opendevelopers" : (edx_rtd_url("edx-developer-guide"), None),
"opendataapi" : (edx_rtd_url("edx-data-analytics-api"), None),
"openreleasenotes" : (edx_rtd_url("open-edx-release-notes"), None),
"partnerreleasenotes": (edx_rtd_url("edx-release-notes"), None),
"2014releasenotes" : (edx_rtd_url("edx-2013-2014-release-notes"), None),
"retirement" : ("https://user-retirement-guide.readthedocs.io/en/latest/", None),
}
extlinks = {
# :jira:`TNL-4904` becomes: <a href='https://openedx.atlassian.net/browse/TNL-4904'>TNL-4904</a>
'jira': ('https://openedx.atlassian.net/browse/%s', ''),
}