diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e1f1f632d..14a6a9000 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,28 +1,22 @@ -# .readthedocs.yaml -# 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 +# https://docs.readthedocs.io/en/stable/config-file/v2.html build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: python: "3.11" - - # 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 + +sphinx: + configuration: docs/conf.py + builder: html + fail_on_warning: false 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 diff --git a/pyproject.toml b/pyproject.toml index 50fd61dbc..5056ee3fa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -87,7 +87,7 @@ develop = [ "pytest-subtests", "pytest-dependency", "responses", - "jupyter-book", + "jupyter-book<2", "sphinxcontrib-napoleon", ] examples = ["jupyterlab"]