Merge pull request #33 from mlojek/v17_readthedocs_integration

V17 readthedocs integration
mlojek · Feb 6, 2025 · 9c9b5cf · 9c9b5cf
2 parents 83f078e + 185572f
commit 9c9b5cf
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 7 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,19 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+  jobs:
+    pre_build:
+     - make install
+     - make doc
+
+sphinx:
+   configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # Optilab
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 ![Docker Pulls](https://img.shields.io/docker/pulls/mlojek/optilab?logo=Docker&label=Dockerhub%20pulls)
+![Read the Docs](https://img.shields.io/readthedocs/optilab)
 
 Optilab is a lightweight and flexible python framework for testing black-box optimization.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -13,7 +13,7 @@
 project = 'optilab'
 copyright = '2025, Marcin Łojek'
 author = 'Marcin Łojek'
-release = '16'
+release = '17'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,11 +5,7 @@
 
 optilab documentation
 =====================
-
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
-
+Optilab is a python framework for black-box optimization.
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+sphinx-rtd-theme
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "optilab"
-version = "16"
+version = "17"
 authors = [
   { name="mlojek", email="marcin.lojek@pw.edu.pl" },
 ]