From 14beaec208cf91d9771e669bae98ad4ed82d6675 Mon Sep 17 00:00:00 2001 From: "Hammond, Rob" <13874373+RHammond2@users.noreply.github.com> Date: Wed, 6 May 2026 16:58:37 -0700 Subject: [PATCH 1/2] update pyproject for MD readme --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index cabd7202..25dd982e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,7 +10,7 @@ authors = [ {name = "Rob Hammond", email = "rob.hammond@nlr.gov"}, {name = "Jake Nunemaker", email = "jacob.nunemaker@nlr.gov"}, ] -readme = {file = "README.rst", content-type = "text/x-rst"} +readme = {file = "README.md", content-type = "text/markdown"} description = "Offshore Renewables Balance of system and Installation Tool" requires-python = ">3.9" license = {file = "LICENSE"} From 574445b6d3ba36cbfb4f604971f648af88b1e51b Mon Sep 17 00:00:00 2001 From: "Hammond, Rob" <13874373+RHammond2@users.noreply.github.com> Date: Wed, 6 May 2026 16:58:51 -0700 Subject: [PATCH 2/2] update docs build process for new docs --- .github/workflows/gh_pages.yml | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/.github/workflows/gh_pages.yml b/.github/workflows/gh_pages.yml index 3d7a4586..759aa9bd 100644 --- a/.github/workflows/gh_pages.yml +++ b/.github/workflows/gh_pages.yml @@ -13,21 +13,19 @@ jobs: uses: actions/setup-python@v6 with: python-version: '3.13' - - name: install dependencies + - name: Install dependencies run: | - python -m pip install --upgrade pip - python -m pip install . - python -m pip install sphinx - python -m pip install sphinx_rtd_theme - python -m pip install sphinx-click - - name: build documentation + pip install ".[docs]" + + - name: Build the documentation run: | - cd docs - make html - - name: deploy - uses: peaceiris/actions-gh-pages@v3.6.1 + jupyter-book build docs + + - name: Upload artifact + uses: actions/upload-pages-artifact@v5 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs/_build/html - force_orphan: true - full_commit_message: ${{ github.event.head_commit.message }} + path: "docs/_build/html" + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v5