Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation configuration to accomodate changes in readthedocs #285

Merged
merged 2 commits into from
Nov 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,40 +14,35 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import os

# See https://docs.readthedocs.io/en/stable/builds.html#build-environment
on_rtd = os.environ.get('READTHEDOCS') == 'True'


# -- Project information -----------------------------------------------------

project = 'hdf5plugin'
copyright = u'2016-2022, Data analysis unit, European Synchrotron Radiation Facility, Grenoble'
author = 'ESRF - Data Analysis Unit'
project = "hdf5plugin"
copyright = (
"2016-2023, European Synchrotron Radiation Facility, Grenoble"
)
author = "ESRF"

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'nbsphinx',
"sphinx.ext.autodoc",
"nbsphinx",
"sphinx_rtd_theme",
]

if not on_rtd:
extensions.append('sphinx_rtd_theme')

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]


# -- 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 = 'default' if on_rtd else 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"
Loading