Apply suggestions from code review

aiidateam · Sep 12, 2024 · 61ce7e6 · 61ce7e6
1 parent 55210f2
commit 61ce7e6
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 6 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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