Skip to content

Commit

Permalink
Add GH workflow for documentation, fix ci script
Browse files Browse the repository at this point in the history
  • Loading branch information
bonicim committed May 16, 2023
1 parent d31f86b commit 6e5cfc3
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Docs
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme
pip install -r docs/requirements.txt
pip install .'[documentation]'
- name: Sphinx build
run: |
sphinx-build docs/source _build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
Empty file added .nojekyll
Empty file.
2 changes: 0 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ repos:
- id: trailing-whitespace
exclude: ^(docs/|hypernetx.egg-info/|setup.cfg)
- id: check-merge-conflict
- id: no-commit-to-branch
args: ['--branch', 'master'] # blocks master commits. To bypass do git commit --allow-empty

- repo: https://github.com/psf/black
rev: 22.6.0
Expand Down

0 comments on commit 6e5cfc3

Please sign in to comment.