From 6658a5bb68d93d1f63d4d5618938bc13b1df5d91 Mon Sep 17 00:00:00 2001 From: Andreas Pedersen Date: Thu, 18 Jan 2024 11:12:08 +0100 Subject: [PATCH] extract docs dependencies, pipeline rename and clean --- ...umentation-deploy.yml => documentation-build.yml} | 12 +++++++----- pyproject.toml | 8 +++++--- 2 files changed, 12 insertions(+), 8 deletions(-) rename .github/workflows/{documentation-deploy.yml => documentation-build.yml} (82%) diff --git a/.github/workflows/documentation-deploy.yml b/.github/workflows/documentation-build.yml similarity index 82% rename from .github/workflows/documentation-deploy.yml rename to .github/workflows/documentation-build.yml index d22e7651..7a2bfd08 100644 --- a/.github/workflows/documentation-deploy.yml +++ b/.github/workflows/documentation-build.yml @@ -1,8 +1,10 @@ -# This pipeline -# - build html documentation -# - deploy html documentation to gh-pages branch of the same repository +# This pipeline +# - build developer documentation +# - push documentation to gh-pages branch of the same repository +# +# Deployment is handled by pages-build-deployment bot -name: Build and Deploy Documentation +name: Build Documentation and Push to gh-pages Branch # Controls when the workflow will run on: @@ -33,7 +35,7 @@ jobs: - name: Install Pandoc, EasyReflectometry and dependencies run: | sudo apt install pandoc - pip install . '.[dev]' + pip install . '.[docs]' - name: Build and Commit uses: sphinx-notes/pages@master with: diff --git a/pyproject.toml b/pyproject.toml index 0aa41e09..4a7fca81 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,15 +42,17 @@ dev = [ "ipykernel", "jupyter>=1.0.0", "jupyterlab", - "nbsphinx", "plopp", "pytest>=5.2", "pytest-cov>=3.0.0", - "sphinx_book_theme", - "sphinx_autodoc_typehints", "toml>=0.10", "yapf>=0.31.0", ] +docs = [ + "nbsphinx", + "sphinx_book_theme", + "sphinx_autodoc_typehints", +] [project.urls] homepage = "https://docs.easyreflectometry.org"