From b31385fdcf82b751b815b313a9cc86eaf4a5e3d8 Mon Sep 17 00:00:00 2001 From: GeorgeGayno-NOAA <52789452+GeorgeGayno-NOAA@users.noreply.github.com> Date: Wed, 18 Oct 2023 09:22:29 -0400 Subject: [PATCH] Fix 'readthedocs' build failure (#861) Add a new .readthedocs.yaml file, which is now required by ReadTheDocs. Remove references to "sphinxconfig.bibtex", which is not currently used by our documentation. Fixes #860. --- .readthedocs.yaml | 15 +++++++++++++++ docs/requirements.txt | 1 - docs/source/conf.py | 5 ++--- 3 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..c425804db --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +sphinx: + configuration: docs/source/conf.py diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index ef36addc6..000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -sphinxcontrib-bibtex diff --git a/docs/source/conf.py b/docs/source/conf.py index e322267b8..4f5c826ef 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -50,11 +50,10 @@ 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', - 'sphinx.ext.napoleon', - 'sphinxcontrib.bibtex' + 'sphinx.ext.napoleon' ] -bibtex_bibfiles = ['references.bib'] +#bibtex_bibfiles = ['references.bib'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']