From ff4b423ee5d5b8ef84403827178a31e67ca30b8b Mon Sep 17 00:00:00 2001 From: Bas van Beek Date: Thu, 2 Dec 2021 16:53:58 +0100 Subject: [PATCH 1/3] DOC: Remove the deprecated HTML4 writer --- docs/conf.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 893e9d56..9a6c774d 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,11 +29,6 @@ needs_sphinx = '2.4' -# Output is processed with HTML4 writer. -# Default is False. -html4_writer = True - - # Add any Sphinx extension module names here, as strings. # They can be extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ From 084398bb5a912ccb74e7338b72801835a37ee7c6 Mon Sep 17 00:00:00 2001 From: Bas van Beek Date: Thu, 2 Dec 2021 16:55:02 +0100 Subject: [PATCH 2/3] DOC: Do not use conda when building RTD docs It's quite slow --- .environment.yaml | 19 ------------------- .readthedocs.yml | 5 ++--- 2 files changed, 2 insertions(+), 22 deletions(-) delete mode 100644 .environment.yaml diff --git a/.environment.yaml b/.environment.yaml deleted file mode 100644 index c20b1b74..00000000 --- a/.environment.yaml +++ /dev/null @@ -1,19 +0,0 @@ -# conda env create -f environment.yml -n ... - -channels: - - conda-forge - -dependencies: - - pip<=20.2 - - python=3.8 - - h5py - - rdkit - - pandas - - numpy - - scipy - - - pip: - - data-CAT@git+https://github.com/nlesc-nano/data-CAT@master - - nano-CAT@git+https://github.com/nlesc-nano/nano-CAT@master - - plams@git+https://github.com/SCM-NV/PLAMS@a5696ce62c09153a9fa67b2b03a750913e1d0924 - - qmflows@git+https://github.com/SCM-NV/qmflows@master diff --git a/.readthedocs.yml b/.readthedocs.yml index daeb1fe4..4b70f816 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -12,11 +12,10 @@ sphinx: # Optionally build your docs in additional formats such as PDF formats: all -conda: - environment: .environment.yaml - # Optionally set the version of Python and requirements required to build your docs python: install: - method: pip path: . + extra_requirements: + - doc From cde895457469b8dbe06da43f69989e9a22f58c86 Mon Sep 17 00:00:00 2001 From: Bas van Beek Date: Thu, 2 Dec 2021 16:58:00 +0100 Subject: [PATCH 3/3] DOC: Mock `rdkit` when building docs --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 9a6c774d..f8bb4f72 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -253,6 +253,11 @@ # Defaults to False. napoleon_use_admonition_for_references = True +# This value contains a list of modules to be mocked up. +# This is useful when some external dependencies are not met at build time and break the building +# process. You may only specify the root package of the dependencies themselves and +# omit the sub-modules: +autodoc_mock_imports = ["rdkit"] # A string of reStructuredText that will be included at the end of every source file that is read. # This is a possible place to add substitutions that should be available in every file (another being rst_prolog).