Skip to content

Commit 9ee4400

Browse files
authored
[DOC] Update sphinx theme (#825)
1 parent 933fa25 commit 9ee4400

File tree

5 files changed

+58
-33
lines changed

5 files changed

+58
-33
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ daal4py.egg-info
99
*.lib
1010
*.dll
1111
**/.ipynb_checkpoints
12+
doc/_build
1213

1314
# Cython generated code
1415
src/oneapi/oneapi_api.h

doc/sources/_static/favicons.png

467 Bytes
Loading
7.24 KB
Loading

doc/sources/conf.py

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
# The short X.Y version
4444
version = '2021'
4545
# The full version, including alpha/beta/rc tags
46-
release = '2021.2.1'
46+
release = '2021.4'
4747

4848

4949
# -- General configuration ---------------------------------------------------
@@ -96,46 +96,38 @@
9696
# a list of builtin themes.
9797
#
9898
#html_theme = 'alabaster'
99-
html_theme = "sphinx_rtd_theme"
100-
html_theme_options = {
101-
"sidebarwidth": 30,
102-
"nosidebar": False,
103-
}
99+
html_theme = 'sphinx_book_theme'
100+
html_logo = '_static/oneAPI-rgb-rev-100.png'
101+
html_favicon = '_static/favicons.png'
104102

105103
# Theme options are theme-specific and customize the look and feel of a theme
106104
# further. For a list of options available for each theme, see the
107105
# documentation.
108106
#
109-
# html_theme_options = {}
110107

111-
# Add any paths that contain custom static files (such as style sheets) here,
112-
# relative to this directory. They are copied after the builtin static files,
113-
# so a file named "default.css" will overwrite the builtin "default.css".
114-
html_static_path = ['_static']
108+
cookie_link = '''
109+
<p align="right">
110+
<a href=
111+
"https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html">
112+
Cookies
113+
</a>
114+
</p>
115+
'''
115116

116-
html_context = {
117-
'css_files': [
118-
'_static/style.css'
119-
]
117+
html_theme_options = {
118+
'repository_url': 'https://github.com/intel/scikit-learn-intelex',
119+
'path_to_docs': 'doc/sources',
120+
'use_issues_button': True,
121+
'use_edit_page_button': True,
122+
'repository_branch': 'master',
123+
'extra_footer': cookie_link
120124
}
121125

122126

123-
# Custom sidebar templates, must be a dictionary that maps document names
124-
# to template names.
125-
#
126-
# The default sidebars (for documents that don't match any pattern) are
127-
# defined by theme itself. Builtin themes are using these templates by
128-
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
129-
# 'searchbox.html']``.
130-
#
131-
# html_sidebars = {}
132-
html_sidebars = {
133-
'**': [
134-
'globaltoc.html', 'relations.html',
135-
'sourcelink.html', 'searchbox.html'
136-
]
137-
}
138-
127+
# Add any paths that contain custom static files (such as style sheets) here,
128+
# relative to this directory. They are copied after the builtin static files,
129+
# so a file named "default.css" will overwrite the builtin "default.css".
130+
html_static_path = ['_static']
139131

140132
# -- Options for HTMLHelp output ---------------------------------------------
141133

requirements-doc.txt

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
Sphinx==4.2.0
2-
sphinx-rtd-theme==1.0.0
1+
alabaster==0.7.12
2+
Babel==2.9.1
3+
beautifulsoup4==4.10.0
4+
certifi==2021.10.8
5+
charset-normalizer==2.0.7
6+
click==8.0.3
7+
docutils==0.16
8+
idna==3.3
9+
imagesize==1.2.0
10+
importlib-metadata==4.8.1
11+
importlib-resources==3.3.1
12+
Jinja2==3.0.2
13+
MarkupSafe==2.0.1
14+
packaging==21.0
15+
pkg-resources==0.0.0
16+
pydata-sphinx-theme==0.6.3
17+
Pygments==2.10.0
18+
pyparsing==2.4.7
19+
pytz==2021.3
20+
PyYAML==6.0
21+
requests==2.26.0
22+
snowballstemmer==2.1.0
23+
soupsieve==2.2.1
24+
Sphinx==3.5.4
25+
sphinx-book-theme==0.1.6
26+
sphinxcontrib-applehelp==1.0.2
27+
sphinxcontrib-devhelp==1.0.2
28+
sphinxcontrib-htmlhelp==2.0.0
29+
sphinxcontrib-jsmath==1.0.1
30+
sphinxcontrib-qthelp==1.0.3
31+
sphinxcontrib-serializinghtml==1.1.5
32+
typing-extensions==3.10.0.2
33+
urllib3==1.26.7
34+
zipp==3.6.0

0 commit comments

Comments
 (0)