Skip to content

Commit

Permalink
Fixed readthedocs build.
Browse files Browse the repository at this point in the history
  • Loading branch information
cgohil8 committed Feb 8, 2024
1 parent 64ff6eb commit 4b26afb
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-20.04
tools:
python: "3.9"
python: "3.8"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
Expand Down
26 changes: 15 additions & 11 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@

# -- Path setup --------------------------------------------------------------

import os
import sys
import inspect

__location__ = os.path.join(
os.getcwd(), os.path.dirname(inspect.getfile(inspect.currentframe()))
)

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

sys.path.insert(0, os.path.join(__location__, "../.."))

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

Expand All @@ -31,7 +35,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
#'sphinx_gallery.gen_gallery',
'sphinx_gallery.gen_gallery',
'sphinx.ext.autosummary',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
Expand Down Expand Up @@ -69,11 +73,11 @@

# -- Sphinx Options ---------------------------------------------------------

#sphinx_gallery_conf = {
# 'examples_dirs': 'tutorials', # path to your example scripts
# 'gallery_dirs': 'build_tutorials', # path to where to save gallery generated output
# 'filename_pattern': '/osl_tutorial_',
#}
sphinx_gallery_conf = {
'examples_dirs': 'tutorials', # path to your example scripts
'gallery_dirs': 'build_tutorials', # path to where to save gallery generated output
'filename_pattern': '/osl_tutorial_',
}

intersphinx_mapping = {'mne': ('https://mne.tools/stable/', None),
'osl': ('https://osl.readthedocs.io/en/improve_docs/', None),
Expand Down
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ nilearn~=0.10.2
nibabel~=5.0.1
opencv-python~=4.7.0.72
numba~=0.56.4
parse~=1.19.0
dask~=2023.3.2

# Docs
sphinx
Expand Down

0 comments on commit 4b26afb

Please sign in to comment.