Update support for ReadTheDocs (#13)

.readthedocs.yaml

@@ -10,4 +10,7 @@ sphinx:
 
 python:
    install:
-   - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -10,6 +10,7 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/piglot)](https://pypi.org/project/piglot/)
 [![GitHub License](https://img.shields.io/github/license/CM2S/piglot)](https://github.com/CM2S/piglot/blob/main/LICENSE)
 [![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/CM2S/piglot)](https://www.codefactor.io/repository/github/cm2s/piglot)
+[![ReadTheDocs](https://img.shields.io/readthedocs/piglot)](https://piglot.readthedocs.io)
 
 A package for the optimisation of numerical responses.
 

docs/source/conf.py

@@ -75,10 +75,7 @@
 # -- Options for HTML output -------------------------------------------------
 
 # Readthedocs theme
-on_rtd = os.environ.get("READTHEDOCS", None) == "True"
-# Only set the theme if building locally
-if not on_rtd:
-    html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/index.rst

@@ -28,6 +28,10 @@ piglot
    :target: https://www.codefactor.io/repository/github/cm2s/piglot
    :alt: CodeFactor Grade
 
+.. image:: https://img.shields.io/readthedocs/piglot
+   :target: https://piglot.readthedocs.io
+   :alt: ReadTheDocs
+
 Welcome to :code:`piglot`, a Python tool taylored for the automated optimisation of responses from numerical solvers.
 We aim at providing a simple and user-friendly interface which is also easily extendable, allowing intergration with other solvers within the community.
 Whether you're working on structural analysis, material modelling, fluid dynamics, control systems or astrophysics (to name a few) using, for instance, finite element analysis, spectral methods or Monte Carlo methods, :code:`piglot` provides a versatile solution for solving inverse problems.
@@ -38,6 +42,8 @@ We highlight:
 - **Optimisation algorithms:** Off the shelf, there are several optimisers included in the package. Among them, we highlight our fully-fledged Bayesian optimisation (based on `BoTorch <https://botorch.org/>`_) that supports optimising stochastic and composite objectives and is highly customisable. Additional methods can also be easily implemented within :code:`piglot`.
 - **Visualisation tools:** You can use the builtin tool :code:`piglot-plot` to visualise the results of the optimisation. There are native plotting utilities for the optimised responses, the parameter history, objective history and, for supported solvers, live plotting of the currently running case. Also, an animation of the optimisation process can be exported.
 
+Feel free to explore, contribute, and optimize with :code:`piglot`!
+
 
 Installation
 ------------

pyproject.toml

@@ -49,6 +49,7 @@ test = ["pytest", "pytest-cov", "flake8", "coverage"]
 
 [project.urls]
 "Homepage" = "https://github.com/CM2S/piglot"
+"Documentation" = "https://piglot.readthedocs.io/en/latest/"
 "Bug Reports" = "https://github.com/CM2S/piglot/issues"
 "Source" = "https://github.com/CM2S/piglot/"