diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..26780a8 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -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 diff --git a/README.md b/README.md index a8e92b8..8876ffc 100644 --- a/README.md +++ b/README.md @@ -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/)