From 61ce7e60ab6709a82d394f437e41d54f3c953048 Mon Sep 17 00:00:00 2001 From: Alexander Goscinski Date: Thu, 12 Sep 2024 14:38:52 +0200 Subject: [PATCH] Apply suggestions from code review --- .readthedocs.yml | 3 --- README.md | 2 +- docs/conf.py | 2 +- requirements.txt | 2 +- 4 files changed, 3 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index d9fa18a9..d7c9d85f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -37,6 +37,3 @@ conda: environment: environment.yml # Optionally set the version of Python and requirements required to build your docs -#python: -# install: -# - requirements: requirements.txt diff --git a/README.md b/README.md index 063badb6..6e1da2fc 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ conda env create --quiet --name aiida-tutorials --file environment.yml conda activate aiida-tutorials pre-commit install # enable pre-commit hooks (optional) make -C docs html # to build docs -make -C docs html linkcheck # to run link checks +make -C docs linkcheck # to run link checks (only for dev) # open build/html/index.html ``` diff --git a/docs/conf.py b/docs/conf.py index 78134b47..a4f30e55 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -399,7 +399,7 @@ "http://127.0.0.1:8000/workgraph", ] -# we don't want to run the notebook +# We are not installing a full aiida environment nb_execution_mode = "off" # Intersphinx configuration diff --git a/requirements.txt b/requirements.txt index bcf2a426..bd6cd99e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,7 +4,7 @@ sphinx-book-theme~=1.1.3 sphinx-copybutton~=0.5.2 sphinx-panels~=0.4.1 sphinx-tabs~=3.4.5 -sphinx-gallery +sphinx-gallery~=0.17.1 myst-nb~=1.1.1 # to run notebooks aiida-quantumespresso