Skip to content

Commit

Permalink
Add workflow to push built doc to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ericpre committed Jan 4, 2024
1 parent ce966e2 commit 242e0f8
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "github-actions" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
target-branch: "main"
21 changes: 21 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Documentation

on: [push, pull_request]

jobs:
Build:
# Use the "reusable workflow" from the hyperspy organisation
uses: hyperspy/.github/.github/workflows/doc.yml@main
with:
doc_build_path: './_build/html/'
# install only depencies using pip
install_dependencies_only: true

Push:
needs: Build
if: ${{ github.event_name != 'pull_request' && github.repository_owner == 'hyperspy' }}
permissions:
# needs write permission to push the docs to gh-pages
contents: write
# Use the "reusable workflow" from the hyperspy organisation
uses: hyperspy/.github/.github/workflows/push_doc.yml@main

0 comments on commit 242e0f8

Please sign in to comment.