Skip to content

Commit a9c1fd0

Browse files
committed
doc: updates to open source site
1 parent 1cbb58d commit a9c1fd0

File tree

5 files changed

+19
-7
lines changed

5 files changed

+19
-7
lines changed

cmake/Sphinx.cmake

+3-2
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,9 @@ if (Python_FOUND AND SPHINX_FOUND)
5454
${SPHINX_SOURCE_DIR}/_static
5555
COMMAND ${Python_EXECUTABLE}
5656
${CMAKE_CURRENT_BINARY_DIR}/cleanup.py ${SPHINX_SOURCE_DIR}
57-
COMMAND ${SPHINX_EXECUTABLE} -b ${SPHINX_GENERATOR}
58-
-D release=v${PROJECT_VERSION} -j auto rst ${SPHINX_OUTPUT_DIR}
57+
COMMAND ${CMAKE_COMMAND} -E env PROJECT_VERSION=v${PROJECT_VERSION}
58+
${SPHINX_EXECUTABLE} -b ${SPHINX_GENERATOR}
59+
-j auto rst ${SPHINX_OUTPUT_DIR}
5960
COMMAND ${CMAKE_COMMAND} -E touch ${SPHINX_STAMP_FILE}
6061
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/reference
6162
COMMENT "Generating API documentation with Sphinx" VERBATIM)

doc/rst/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
oneAPI Deep Neural Network Library Developer Guide and Reference
2-
=======================================================================
1+
oneAPI Deep Neural Network Library (oneDNN) Developer Guide and Reference
2+
=========================================================================
33

44
.. toctree::
55
:maxdepth: 1

doc/sphinx/_static/favicons.png

467 Bytes
Loading
7.24 KB
Loading

doc/sphinx/conf.py

+14-3
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,11 @@ def whereis(binary):
5151
# -- Project information -----------------------------------------------------
5252

5353
project = 'oneDNN'
54-
copyright = '2016-2024 Intel Corporation'
54+
copyright = '2016-2025 Intel Corporation'
5555
author = ''
5656

57+
release = os.environ.get("PROJECT_VERSION", "unknown")
58+
5759
# -- General configuration ---------------------------------------------------
5860

5961
# Add any Sphinx extension module names here, as strings. They can be
@@ -116,6 +118,8 @@ def whereis(binary):
116118
# Add any paths that contain templates here, relative to this directory.
117119
templates_path = ['_templates']
118120

121+
source_suffix = '.rst'
122+
119123
# List of patterns, relative to source directory, that match files and
120124
# directories to ignore when looking for source files.
121125
# This pattern also affects html_static_path and html_extra_path.
@@ -135,13 +139,20 @@ def whereis(binary):
135139
html_static_path = ['_static']
136140
#html_js_files = [('dnnl.js', {'defer': 'defer'})]
137141

142+
html_logo = '_static/oneAPI-rgb-rev-100.png'
143+
html_favicon = '_static/favicons.png'
144+
138145
html_theme_options = {
139146
"repository_url": "https://github.com/oneapi-src/oneDNN",
140-
"repository_branch": "master",
147+
"repository_branch": "main",
141148
"use_repository_button": True,
142-
"use_download_button": False
149+
"use_download_button": True,
150+
"path_to_docs": "doc",
151+
"use_issues_button": True
143152
}
144153

154+
html_theme_options["logo"] = {"text": "oneDNN Documentation\n" + release}
155+
145156
mathjax3_config = {
146157
'tex': {
147158
'macros': {

0 commit comments

Comments
 (0)