mirror of
https://github.com/ImperialCollegeLondon/ReCoDE_MCMCFF.git
synced 2025-06-26 08:51:16 +02:00
Add docs GitHub Action
This is a temporary solution until we figure out how to deploy readthedocs via GitHub Actions on a GitHub page.
This commit is contained in:
parent
f944a7edfe
commit
f68a8522e8
18
.github/workflows/docs.yml
vendored
Normal file
18
.github/workflows/docs.yml
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
name: "Docs"
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
docs:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- uses: sphinx-toolbox/sphinx-action@master
|
||||||
|
with:
|
||||||
|
pre-build-command: "pip install .[docs]"
|
||||||
|
docs-folder: "docs/"
|
||||||
|
- name: Deploy
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
if: github.ref == 'refs/heads/main'
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
publish_dir: docs/_build/html
|
Loading…
x
Reference in New Issue
Block a user