From ab333d0a9d479efeca6b437f15538a1731da8621 Mon Sep 17 00:00:00 2001 From: rafa-be Date: Fri, 18 Oct 2024 02:45:09 +0200 Subject: [PATCH] Adds a GitHub Action that publishes the Scaler docs. (#31) Signed-off-by: rafa-be --- .github/workflows/documentation.yml | 41 +++++++++++++++++++++++++++++ docs/requirements_docs.txt | 1 - docs/source/conf.py | 1 - scaler/about.py | 2 +- 4 files changed, 42 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..22c5e07 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,41 @@ +name: Publish documentation to GitHub Pages + +on: + release: + types: [created] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Python 3.8 + uses: actions/setup-python@v5 + with: + python-version: "3.8" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install -r docs/requirements_docs.txt + + - name: Build documentation + run: cd docs && make html + + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: './docs/build/html' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/requirements_docs.txt b/docs/requirements_docs.txt index 919506d..85e44e0 100644 --- a/docs/requirements_docs.txt +++ b/docs/requirements_docs.txt @@ -1,4 +1,3 @@ sphinx -sphinx-jsonschema sphinx_rtd_theme sphinx-substitution-extensions diff --git a/docs/source/conf.py b/docs/source/conf.py index f513502..f2fca81 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -40,7 +40,6 @@ "sphinx.ext.doctest", "sphinx_substitution_extensions", "sphinx.ext.napoleon", - "sphinx-jsonschema", "sphinx.ext.autosectionlabel", ] diff --git a/scaler/about.py b/scaler/about.py index 490fbd4..d3d41ce 100644 --- a/scaler/about.py +++ b/scaler/about.py @@ -1 +1 @@ -__version__ = "1.8.9" +__version__ = "1.8.10"