Skip to content

Commit

Permalink
Create documentation.yml
Browse files Browse the repository at this point in the history
poetry lock
  • Loading branch information
RobinsonBeaucour authored and RobinsonBeaucour committed Jun 12, 2024
1 parent d750713 commit 0bf7543
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: documentations

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 poetry
poetry lock
poetry install --with doc
- name: Sphinx build
run: |
poetry run sphinx-build -M html ./docs ./docs/_build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
force_orphan: true
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ More recently, it was used in a collaboration between RTE and CEA with the aim o
pip install heatpro
```

- Documentation: [https://heat-load-profile-generator.readthedocs.io](https://heat-load-profile-generator.readthedocs.io)
- Documentation: [https://cea-liten.github.io/HeatPro/](https://cea-liten.github.io/HeatPro/)



0 comments on commit 0bf7543

Please sign in to comment.