Skip to content

Commit

Permalink
fix build of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rscohn2 committed May 19, 2024
1 parent 8442d54 commit adea669
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 213 deletions.
201 changes: 0 additions & 201 deletions docs/conf.py

This file was deleted.

32 changes: 20 additions & 12 deletions docs/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# documentation root, use os.path.abspath to make it absolute, as shown here.
#
# import os
# import sys
Expand All @@ -20,7 +20,7 @@
# -- Project information -----------------------------------------------------

project = 'oneAPI Math Kernel Library Interfaces'
copyright = '2020, Intel Corporation'
copyright = '2020-2022, Intel Corporation'
author = 'Intel Corporation'

# The short X.Y version
Expand All @@ -41,7 +41,6 @@ release = '0.1'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
]

Expand All @@ -62,7 +61,7 @@ master_doc = 'index'
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand All @@ -72,24 +71,38 @@ exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None

static_dir = '@CMAKE_CURRENT_SOURCE_DIR@/_static'


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_book_theme'
html_logo = f'{static_dir}/oneAPI-rgb-rev-100.png'
html_favicon = f'{static_dir}/favicons.png'

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

# Theme options
html_theme_options = {
'repository_url': 'https://github.com/oneapi-src/oneMKL',
'path_to_docs': 'docs',
'use_issues_button': True,
'use_edit_page_button': True,
'repository_branch': 'develop',
'extra_footer': '<p align="right"><a href="https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html">Cookies</a></p>',
'navigation_with_keys': False,
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = [static_dir]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down Expand Up @@ -179,11 +192,6 @@ epub_exclude_files = ['search.html']

# -- Extension configuration -------------------------------------------------

# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Sphinx
sphinx-book-theme

0 comments on commit adea669

Please sign in to comment.