Merge pull request #303 from SCM-NV/doc

DOC: Fix documentation building
SCM-NV · Jul 5, 2023 · a2ccef3 · a2ccef3
2 parents c10f1ba + 6b19e3d
commit a2ccef3
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 12 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -8,21 +8,17 @@ version: 2
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-
-# Configuration for the documentation build process.
-# This allows you to specify the base Read the Docs image used to build the documentation,
-# and control the versions of several tools: Python, Node.js, Rust, and Go.
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
+  fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF
 formats:
   - htmlzip
   - epub
 
 # Optionally set the version of Python and requirements required to build your docs
+conda:
+  environment: doc_environment.yml
+
 python:
   install:
     - method: pip

diff --git a/doc_environment.yml b/doc_environment.yml
@@ -0,0 +1,6 @@
+name: qmflows-doc
+channels:
+  - conda-forge
+dependencies:
+  - python
+  - pandoc  # pandoc on pypi is poorly maintaned; use conda-forge instead
diff --git a/docs/conf.py b/docs/conf.py
@@ -60,7 +60,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'qmflows'
+project = qmflows.__name__
 copyright = '2022, F. Zapata, L. Ridder, B. F. van Beek'
 author = 'F. Zapata, L. Ridder, B. F. van Beek'
 
@@ -69,10 +69,17 @@
 # built documents.
 #
 # The short X.Y version.
-version = qmflows.__version__
+version = f"{qmflows.__version_tuple__[0]}{qmflows.__version_tuple__[1]}"
 # The full version, including alpha/beta/rc tags.
 release = qmflows.__version__
 
+
+# A list of warning types to suppress arbitrary warning messages.
+suppress_warnings = [
+    "epub.unknown_project_files",
+]
+
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #

diff --git a/pyproject.toml b/pyproject.toml
@@ -59,7 +59,7 @@ Documentation = "https://qmflows.readthedocs.io/en/latest/"
 
 [project.optional-dependencies]
 doc = [
-    "sphinx>=2.1,!=3.1.1",
+    "sphinx>=2.1,!=3.1.1,<7",
     "sphinx-autodoc-typehints",
     "sphinx_rtd_theme",
     "nbsphinx",

diff --git a/scripts/download_cp2k.sh b/scripts/download_cp2k.sh
@@ -39,7 +39,6 @@ case "$OS" in
         esac
         ;;
     "macos"*)
-        brew update
         brew install cp2k
         echo -e \n::endgroup::\n
         ;;