From 4762af8a2dbad9708fa49e04a79bf9eb61f75f70 Mon Sep 17 00:00:00 2001 From: basejumpa Date: Mon, 6 Nov 2023 12:37:14 +0100 Subject: [PATCH] Skeleton code for website --- .github/workflows/run.yml | 55 +++++++++++++++++++++++++++++++++++++++ .gitignore | 3 +++ doc/conf.py | 0 doc/index.rst | 1 + requirements.txt | 1 + 5 files changed, 60 insertions(+) create mode 100644 .github/workflows/run.yml create mode 100644 .gitignore create mode 100644 doc/conf.py create mode 100644 doc/index.rst create mode 100644 requirements.txt diff --git a/.github/workflows/run.yml b/.github/workflows/run.yml new file mode 100644 index 0000000..94f8795 --- /dev/null +++ b/.github/workflows/run.yml @@ -0,0 +1,55 @@ +# This is a basic workflow to help you get started with Actions + +name: run + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the "main" branch + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v3 + + - name: Install python stuff + run: | + python -m pip install --upgrade pipenv wheel + pipenv install -r requirements.txt + + - name: Build main website + run: pipenv run sphinx-build doc build/html + + - name: Upload website to artifacts + uses: actions/upload-pages-artifact@v1 + with: + path: './build/html' + + - name: Publish website at GitHub Pages + id: deployment + if: github.ref == 'refs/heads/main' + uses: actions/deploy-pages@v1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d180001 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.venv/ +Pipfile +build/ diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..e69de29 diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..10ddd6d --- /dev/null +++ b/doc/index.rst @@ -0,0 +1 @@ +Hello! diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6966869 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +sphinx