Skip to content

Commit

Permalink
Skeleton code for website
Browse files Browse the repository at this point in the history
  • Loading branch information
basejumpa committed Nov 6, 2023
1 parent 5a1dd38 commit 4762af8
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/run.yml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.venv/
Pipfile
build/
Empty file added doc/conf.py
Empty file.
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Hello!
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx

0 comments on commit 4762af8

Please sign in to comment.