updates `adds .readthedocs.yaml and requirements-docs.txt and modifie…

…s tox.in and requirements-dev.txt (#115)
SciKit-Surgery · Jun 22, 2023 · 0f34af6 · 0f34af6
1 parent 410edbb
commit 0f34af6
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 2 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,23 @@
+# .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.8"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements-docs.txt
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -10,8 +10,6 @@ mock
 pyfakefs
 parameterized
 pylint<=2.17.0
-sphinx
-sphinx_rtd_theme
 pyinstaller
 pytest
 tox

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -0,0 +1,5 @@
+-r requirements.txt
+six
+docutils
+sphinx
+sphinx_rtd_theme
diff --git a/tox.ini b/tox.ini
@@ -29,6 +29,7 @@ commands=pylint --rcfile=tests/pylintrc --extension-pkg-whitelist=PySide6,vtk,cv
 [testenv:docs]
 basepython=python3.8
 changedir = doc
+deps=-rrequirements-docs.txt
 commands = sphinx-build -M html . build
 
 [testenv:installer]