diff --git a/.gitignore b/.gitignore index fbf36f5..b174bb2 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ /docs/_build/ /.mypy_cache/ /optibess_algorithm.egg-info/ -/.tox/ \ No newline at end of file +/.tox/ +/dist/ diff --git a/.readthedocs.yml b/.readthedocs.yml index fc96b04..a7e8a32 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,4 +1,4 @@ -version: "2" +version: 2 build: os: "ubuntu-22.04" @@ -10,4 +10,8 @@ python: - requirements: docs/requirements.txt sphinx: - configuration: docs/conf.py \ No newline at end of file + configuration: docs/conf.py + +formats: + - pdf + - epub \ No newline at end of file diff --git a/README.rst b/README.rst index e865de0..c6c5264 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ Optibess Algorithm - optimizing PV system combined with storage -============================================================== +=============================================================== **Optibess Algorithm** is a python 3.10+ library for simulating and optimizing a photovoltaic system with power storage. It uses data from *pvgis* and algorithms from the *pvlib* and *Nevergrad* python libraries, and is the backend part of @@ -11,15 +11,13 @@ the *Optibess* site. .. image:: https://codecov.io/gh/pvstorageoptimization/Optibess_algorithm/graph/badge.svg?token=L3VLK1Y1SM :target: https://codecov.io/gh/pvstorageoptimization/Optibess_algorithm -|Documentation Status| +|Documentation Status| |PyPI version shields.io| -.. |Documentation Status| image:: https://readthedocs.org/projects/optibess-algorithm/badge/?version=stable - :target: http://optibess-algorithm.readthedocs.io/?badge=stable +.. |Documentation Status| image:: https://readthedocs.org/projects/optibess-algorithm/badge/?version=latest + :target: http://optibess-algorithm.readthedocs.io/?badge=latest -|PyPI download total| - -.. |PyPI download total| image:: https://img.shields.io/pypi/dt/.svg - :target: https://pypi.python.org/pypi/ +.. |PyPI version shields.io| image:: https://img.shields.io/pypi/v/optibess-algorithm.svg + :target: https://pypi.org/project/optibess-algorithm/ Quick start ------------ diff --git a/pyproject.toml b/pyproject.toml index f92ce01..a028e30 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,7 +38,8 @@ testing = [ ] [project.urls] -homepage = "https://github.com/pvstorageoptimization/Optibess_algorithm.git" +homepage = "https://github.com/pvstorageoptimization/Optibess_algorithm" +docs = "https://optibess-algorithm.readthedocs.io" [tool.setuptools] packages = ["optibess_algorithm"]