From a58fe24dd20dcb719b7894a0fb986ca73a830ce7 Mon Sep 17 00:00:00 2001 From: John Jasa Date: Thu, 27 Nov 2025 18:23:26 -0700 Subject: [PATCH 1/7] Minor change to debug RTD build --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a3b227264..532a6c922 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,6 @@ As part of NREL's [Hybrid Energy Systems Research](https://www.nrel.gov/wind/hyb software assesses optimal designs for the deployment of distributed, commercial, and utility-scale hybrid energy plants, particularly considering wind, solar and storage. - -## Part of the WETO Stack - -HOPP is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://nrel.github.io/WETOStack). For more information and other integrated modeling software, see: -- [Portfolio Overview](https://nrel.github.io/WETOStack/portfolio_analysis/overview.html) -- [Entry Guide](https://nrel.github.io/WETOStack/_static/entry_guide/index.html) -- [Techno-Economic Modeling Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#tea-and-cost-modeling) -- [Systems Engineering Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#systems-engineering) - - ## Software requirements - Python version 3.11 or higher @@ -108,3 +98,11 @@ The [Examples](./examples/) contain Jupyter notebooks and sample YAML files for Interested in improving HOPP? Please see the [Contributor's Guide](docs/CONTRIBUTING.md) for more information. + +## Part of the WETO Stack + +HOPP is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://nrel.github.io/WETOStack). For more information and other integrated modeling software, see: +- [Portfolio Overview](https://nrel.github.io/WETOStack/portfolio_analysis/overview.html) +- [Entry Guide](https://nrel.github.io/WETOStack/_static/entry_guide/index.html) +- [Techno-Economic Modeling Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#tea-and-cost-modeling) +- [Systems Engineering Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#systems-engineering) \ No newline at end of file From da082b11ac0164024f6eaf7a7e5f8071036530e1 Mon Sep 17 00:00:00 2001 From: John Jasa Date: Thu, 27 Nov 2025 18:29:09 -0700 Subject: [PATCH 2/7] Minor change to debug RTD build --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 50fd61dbc..0a277c671 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -89,6 +89,7 @@ develop = [ "responses", "jupyter-book", "sphinxcontrib-napoleon", + "nodejs", ] examples = ["jupyterlab"] all = ["hopp[develop,examples]"] From a8e438ba1d382e016aafe916f45c3adda1bcc6a0 Mon Sep 17 00:00:00 2001 From: John Jasa Date: Thu, 27 Nov 2025 18:30:23 -0700 Subject: [PATCH 3/7] Minor change to debug RTD build --- .readthedocs.yaml | 6 ++---- pyproject.toml | 1 - 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e1f1f632d..0d7fee7b0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -2,27 +2,25 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required version: 2 sphinx: # Path to your Sphinx configuration file. configuration: docs/conf.py -# Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" + nodejs: "18" # add Node.js for the doc build (choose version as needed) # Generate the Sphinx configuration for Jupyter Book so it builds jobs: pre_build: - "jupyter-book config sphinx docs/" -# Set the build to use dependencies in pyproject.toml python: install: - method: pip path: . extra_requirements: - - develop \ No newline at end of file + - develop diff --git a/pyproject.toml b/pyproject.toml index 0a277c671..50fd61dbc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -89,7 +89,6 @@ develop = [ "responses", "jupyter-book", "sphinxcontrib-napoleon", - "nodejs", ] examples = ["jupyterlab"] all = ["hopp[develop,examples]"] From ce3a08fe009165d6587f45a3c7fff119b47748e2 Mon Sep 17 00:00:00 2001 From: John Jasa Date: Thu, 27 Nov 2025 18:35:40 -0700 Subject: [PATCH 4/7] Updating to ubuntu 24 for docs build --- .readthedocs.yaml | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0d7fee7b0..14a6a9000 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,19 +1,10 @@ -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - version: 2 -sphinx: - # Path to your Sphinx configuration file. - configuration: docs/conf.py +# https://docs.readthedocs.io/en/stable/config-file/v2.html build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: python: "3.11" - nodejs: "18" # add Node.js for the doc build (choose version as needed) - - # Generate the Sphinx configuration for Jupyter Book so it builds jobs: pre_build: - "jupyter-book config sphinx docs/" @@ -23,4 +14,9 @@ python: - method: pip path: . extra_requirements: - - develop + - develop + +sphinx: + configuration: docs/conf.py + builder: html + fail_on_warning: false From 53510a1c875ab839a4817a7f44dd032bf31aaac2 Mon Sep 17 00:00:00 2001 From: John Jasa Date: Thu, 27 Nov 2025 19:23:17 -0700 Subject: [PATCH 5/7] Trying nodejs install --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 14a6a9000..f023a1229 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,6 +15,7 @@ python: path: . extra_requirements: - develop + - nodejs sphinx: configuration: docs/conf.py From d1144146b47f9dc5b184744be9a027ee7906a312 Mon Sep 17 00:00:00 2001 From: John Jasa Date: Mon, 1 Dec 2025 09:48:45 -0700 Subject: [PATCH 6/7] Adding nodejs to pyproject --- .readthedocs.yaml | 1 - pyproject.toml | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f023a1229..14a6a9000 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,7 +15,6 @@ python: path: . extra_requirements: - develop - - nodejs sphinx: configuration: docs/conf.py diff --git a/pyproject.toml b/pyproject.toml index 50fd61dbc..cc2d99686 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -88,6 +88,7 @@ develop = [ "pytest-dependency", "responses", "jupyter-book", + "nodejs", "sphinxcontrib-napoleon", ] examples = ["jupyterlab"] From f20eda33936189298383e34dd430ffe9845d7f63 Mon Sep 17 00:00:00 2001 From: John Jasa Date: Mon, 1 Dec 2025 10:34:46 -0700 Subject: [PATCH 7/7] Pinning jupyter-book<2 --- pyproject.toml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index cc2d99686..5056ee3fa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -87,8 +87,7 @@ develop = [ "pytest-subtests", "pytest-dependency", "responses", - "jupyter-book", - "nodejs", + "jupyter-book<2", "sphinxcontrib-napoleon", ] examples = ["jupyterlab"]