Repair readthedocs build.

dynamicslab · Jan 29, 2024 · 7a87193 · 7a87193
1 parent 43c0968
commit 7a87193
Show file tree

Hide file tree

Showing 23 changed files with 103 additions and 91 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+   os: ubuntu-22.04
+   tools:
+     python: "3.10"
+     # You can also specify other tool versions:
+     # nodejs: "16"
+     # rust: "1.55"
+     # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .
diff --git a/docs/FlowConfigurations.md b/docs/FlowConfigurations.md
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,8 +1,8 @@
 # Minimal makefile for Sphinx documentation
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/RayClusterSetup.md b/docs/RayClusterSetup.md
diff --git a/docs/Status051822.md b/docs/Status051822.md
diff --git a/docs/source/_static/imgs/cavity.png → docs/_static/imgs/cavity.png b/docs/source/_static/imgs/cavity.png → docs/_static/imgs/cavity.png
diff --git a/docs/source/_static/imgs/cylinder.png → docs/_static/imgs/cylinder.png b/docs/source/_static/imgs/cylinder.png → docs/_static/imgs/cylinder.png
diff --git a/docs/source/_static/imgs/logo.svg → docs/_static/imgs/logo.svg b/docs/source/_static/imgs/logo.svg → docs/_static/imgs/logo.svg
diff --git a/docs/source/_static/imgs/pinball.png → docs/_static/imgs/pinball.png b/docs/source/_static/imgs/pinball.png → docs/_static/imgs/pinball.png
diff --git a/docs/source/api.rst → docs/api.rst b/docs/source/api.rst → docs/api.rst
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -3,8 +3,8 @@
 # -- Project information
 
 project = "Hydrogym"
-copyright = "2022, Hydrogym Developers"
-author = "tbd"
+copyright = "2023, Hydrogym Developers"
+author = "Ludger Paehler"
 
 release = "0.1"
 version = "0.1.0"
@@ -20,6 +20,7 @@
 ]
 
 intersphinx_mapping = {
+    "rtd": ("https://docs.readthedocs.io/en/stable/", None),
     "python": ("https://docs.python.org/3/", None),
     "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
 }
@@ -31,5 +32,8 @@
 
 html_theme = "alabaster"
 
+# Custom paths for static files
+html_static_path = ["_static"]
+
 # -- Options for EPUB output
-epub_show_urls = "footnote"
+epub_show_urls = "footnote"
diff --git a/docs/source/distributed_backend.rst → docs/distributed_backend.rst b/docs/source/distributed_backend.rst → docs/distributed_backend.rst
diff --git a/docs/source/docker_development.rst → docs/docker_development.rst b/docs/source/docker_development.rst → docs/docker_development.rst
diff --git a/docs/source/further_backend.rst → docs/further_backend.rst b/docs/source/further_backend.rst → docs/further_backend.rst
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
diff --git a/docs/source/installation.rst → docs/installation.rst b/docs/source/installation.rst → docs/installation.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=source
-set BUILDDIR=build
+set SOURCEDIR=.
+set BUILDDIR=_build
 
 if "%1" == "" goto help
 
@@ -25,11 +25,13 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
 :end
-popd
+popd
diff --git a/docs/source/parallel_scaling.rst → docs/parallel_scaling.rst b/docs/source/parallel_scaling.rst → docs/parallel_scaling.rst
diff --git a/docs/source/quickstart.rst → docs/quickstart.rst b/docs/source/quickstart.rst → docs/quickstart.rst
diff --git a/docs/source/ray.rst → docs/ray.rst b/docs/source/ray.rst → docs/ray.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,58 @@
+#
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
+#
+#    pip-compile docs/requirements.in
+#
+alabaster==0.7.12
+    # via sphinx
+babel==2.10.3
+    # via sphinx
+certifi==2022.6.15
+    # via requests
+charset-normalizer==2.1.0
+    # via requests
+docutils==0.17.1
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+idna==3.3
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.2
+    # via sphinx
+markupsafe==2.1.1
+    # via jinja2
+packaging==21.3
+    # via sphinx
+pygments==2.12.0
+    # via sphinx
+pyparsing==3.0.9
+    # via packaging
+pytz==2022.1
+    # via babel
+requests==2.28.1
+    # via sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==5.0.2
+    # via
+    #   -r docs/requirements.in
+    #   sphinx-rtd-theme
+sphinx-rtd-theme==1.0.0
+    # via -r docs/requirements.in
+sphinxcontrib-applehelp==1.0.2
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.0
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+urllib3==1.26.9
+    # via requests
diff --git a/docs/source/rllib.rst → docs/rllib.rst b/docs/source/rllib.rst → docs/rllib.rst
diff --git a/docs/source/torch_rl.rst → docs/torch_rl.rst b/docs/source/torch_rl.rst → docs/torch_rl.rst