Skip to content

Commit

Permalink
Add: Add a sphinx based documentation #340
Browse files Browse the repository at this point in the history
Sphinx based documentation for autohooks
  • Loading branch information
bjoernricks committed Aug 16, 2022
2 parents 2ce2ba8 + c950713 commit 25e65c2
Show file tree
Hide file tree
Showing 24 changed files with 2,023 additions and 370 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy docs to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
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

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install poetry and dependencies
uses: greenbone/actions/poetry@v1
with:
version: "3.9"
- name: Build Documentation
run: |
cd docs && poetry run make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: 'docs/build'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
Loading

0 comments on commit 25e65c2

Please sign in to comment.