Create documentation.yml

poetry lock

.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

README.md

@@ -3,9 +3,7 @@
 </div>
 
 [![PyPI Version](https://img.shields.io/pypi/v/heatpro.svg)](https://pypi.python.org/pypi/heatpro)
-[![Build Status](https://img.shields.io/travis/NicolasLamaison/heatpro.svg)](https://travis-ci.com/NicolasLamaison/heatpro)
-[![Documentation Status](https://readthedocs.org/projects/heat-load-profile-generator/badge/?version=latest)](https://heat-load-profile-generator.readthedocs.io/en/latest/?version=latest)
-
+[![pages-build-deployment](https://github.com/CEA-Liten/HeatPro/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/CEA-Liten/HeatPro/actions/workflows/pages/pages-build-deployment)
 The present package finds its roots in the need of using representative heating load curve for the simulation and optimization of various District Heating Network (DHN) production plant. The main principle is to disagreggate monthly or yearly heat load into an hourly heat load using an hourly based external temperature profile. The resulting load curve also includes DHN supply and return temperatures.
 
 This package was used for the study of a production plant combining Power-to-Heat, Biomass and Storage ([Lamaison et al., 2019](https://doi.org/10.1016/j.energy.2019.07.044)). It was also the tool used to generate various heat load curves in a study of long term storage management ([Cuisinier et al., 2022](https://doi.org/10.1016/j.energy.2021.122773)).
@@ -47,7 +45,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/)