From b54eca463bf1db3e8ebff685f84ecc45b464ed35 Mon Sep 17 00:00:00 2001 From: "C. Carouge" Date: Wed, 3 May 2023 11:55:54 +1000 Subject: [PATCH 1/2] Add readthedocs for versioning --- .readthedocs.yaml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..7e354bcb --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +mkdocs: + configuration: mkdocs.yml + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: mkdocs-requirements.txt \ No newline at end of file From 787a5fd14ac576fc46dd525f8a1eca4498ce6bca Mon Sep 17 00:00:00 2001 From: "C. Carouge" Date: Wed, 3 May 2023 17:04:27 +1000 Subject: [PATCH 2/2] Delete github pages actions --- .github/actions/build/action.yml | 32 ------------------------- .github/workflows/build_and_preview.yml | 28 ---------------------- .github/workflows/build_and_publish.yml | 25 ------------------- 3 files changed, 85 deletions(-) delete mode 100644 .github/actions/build/action.yml delete mode 100644 .github/workflows/build_and_preview.yml delete mode 100644 .github/workflows/build_and_publish.yml diff --git a/.github/actions/build/action.yml b/.github/actions/build/action.yml deleted file mode 100644 index a1357793..00000000 --- a/.github/actions/build/action.yml +++ /dev/null @@ -1,32 +0,0 @@ -name: Build docs -description: Build mkdocs -inputs: - name: - required: false - description: "Name" - -outputs: - random: - description: "Random number output" - value: ${{ steps.step1.outputs.random }} - -runs: - using: "composite" - steps: - - name: Checkout - uses: actions/checkout@v3 - - - uses: actions/setup-python@v2 - with: - python-version: 3.x - - - name: Install dependencies for mkdocs - run: | - pip install -r mkdocs-requirements.txt - shell: bash - - - name: Build documentation - run: | - # outputs to "site" directory - mkdocs build -f mkdocs.yml - shell: bash diff --git a/.github/workflows/build_and_preview.yml b/.github/workflows/build_and_preview.yml deleted file mode 100644 index bc0a9bea..00000000 --- a/.github/workflows/build_and_preview.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Build and deploy PR preview - -on: - pull_request: - types: - - opened - - reopened - - synchronize - - closed - -concurrency: - group: preview-${{ github.ref }} - cancel-in-progress: true - -jobs: - build_and_deploy_preview: - runs-on: ubuntu-latest - steps: - - name: Checkout # Necessary to access local action - uses: actions/checkout@v3 - - - name: Build docs - uses: ./.github/actions/build - - - name: Deploy preview - uses: rossjrw/pr-preview-action@v1.2 - with: - source-dir: site \ No newline at end of file diff --git a/.github/workflows/build_and_publish.yml b/.github/workflows/build_and_publish.yml deleted file mode 100644 index df62b825..00000000 --- a/.github/workflows/build_and_publish.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Build and publish docs - -on: - push: - branches: - - master - -jobs: - build_and_deploy_docs: - concurrency: ci-${{ github.ref }} - runs-on: ubuntu-latest - steps: - - name: Checkout # Necessary to access local action - uses: actions/checkout@v3 - - - name: Build docs - uses: ./.github/actions/build - - - name: Deploy - uses: JamesIves/github-pages-deploy-action@v4 - with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - branch: gh-pages # default - folder: site - clean-exclude: pr-preview/ # don't overwrite previews \ No newline at end of file