Fix dependencies + CI #208
3 changed files with 11 additions and 2 deletions
1
.github/workflows/docs.yml
vendored
1
.github/workflows/docs.yml
vendored
|
|
@ -35,6 +35,7 @@ jobs:
|
||||||
$SUDO apt-get install git-annex-standalone
|
$SUDO apt-get install git-annex-standalone
|
||||||
python -m pip install --upgrade pip setuptools wheel
|
python -m pip install --upgrade pip setuptools wheel
|
||||||
python -m pip install -e .[docs]
|
python -m pip install -e .[docs]
|
||||||
|
python -m pip install git+https://github.com/dls-controls/sphinx-multiversion@only-arg
|
||||||
- name: Configure git for datalad
|
- name: Configure git for datalad
|
||||||
run: |
|
run: |
|
||||||
git config --global user.email "runner@github.com"
|
git config --global user.email "runner@github.com"
|
||||||
|
|
|
||||||
11
docs/conf.py
11
docs/conf.py
|
|
@ -19,6 +19,13 @@
|
||||||
import sys
|
import sys
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
|
# Check if sphinx-multiversion is installed
|
||||||
|
use_multiversion = False
|
||||||
|
try:
|
||||||
|
import sphinx_multiversion # noqa: F401
|
||||||
|
use_multiversion = True
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
curdir = Path(__file__).parent
|
curdir = Path(__file__).parent
|
||||||
sys.path.append((curdir / "sphinxext").as_posix())
|
sys.path.append((curdir / "sphinxext").as_posix())
|
||||||
|
|
@ -41,12 +48,14 @@ extensions = [
|
||||||
"sphinx.ext.intersphinx", # link to other projects’ documentation
|
"sphinx.ext.intersphinx", # link to other projects’ documentation
|
||||||
"sphinx.ext.mathjax", # math support for HTML outputs in Sphinx
|
"sphinx.ext.mathjax", # math support for HTML outputs in Sphinx
|
||||||
"sphinx_gallery.gen_gallery", # HTML gallery of examples
|
"sphinx_gallery.gen_gallery", # HTML gallery of examples
|
||||||
"sphinx_multiversion", # self-hosted versioned documentation
|
|
||||||
"numpydoc", # support for NumPy style docstrings
|
"numpydoc", # support for NumPy style docstrings
|
||||||
"gh_substitutions", # custom GitHub substitutions
|
"gh_substitutions", # custom GitHub substitutions
|
||||||
"sphinx_copybutton", # copy button for code blocks
|
"sphinx_copybutton", # copy button for code blocks
|
||||||
]
|
]
|
||||||
|
|
||||||
|
if use_multiversion:
|
||||||
|
extensions.append("sphinx_multiversion")
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = [
|
templates_path = [
|
||||||
"_templates",
|
"_templates",
|
||||||
|
|
|
||||||
|
|
@ -67,7 +67,6 @@ docs = [
|
||||||
"Sphinx>=5.3.0,<5.4",
|
"Sphinx>=5.3.0,<5.4",
|
||||||
"sphinx-gallery>=0.11.0,<0.12",
|
"sphinx-gallery>=0.11.0,<0.12",
|
||||||
"furo>=2022.9.29,<2023.0.0",
|
"furo>=2022.9.29,<2023.0.0",
|
||||||
"sphinx-multiversion@git+https://github.com/dls-controls/sphinx-multiversion@only-arg#egg=only-arg",
|
|
||||||
"numpydoc>=1.5.0,<1.6",
|
"numpydoc>=1.5.0,<1.6",
|
||||||
"julearn==0.2.5",
|
"julearn==0.2.5",
|
||||||
"sphinx-copybutton==0.5.1",
|
"sphinx-copybutton==0.5.1",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue