adds .readthedocs.yaml; docs/requirements.txt and updates requirement…

…s-dev.txt and docs/.gitignore (#216)
SciKit-Surgery · May 10, 2023 · 1bb5960 · 1bb5960
1 parent 17b3271
commit 1bb5960
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 6 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,21 @@
+# .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:
+   configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,4 +1,4 @@
 /sksurgeryvtk.rst
 /sksurgeryvtk.*.rst
 /modules.rst
-/build
+/build
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,4 @@
+six<=1.16.0
+sphinx<=5.3.0
+sphinx_rtd_theme<=1.2.0
+nbsphinx<=0.8.12
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -9,14 +9,10 @@ mock<=5.0.1
 pyfakefs<=5.1.0
 parameterized<=0.8.1
 pylint<=2.16.1
-sphinx<=5.3.0
-sphinx_rtd_theme<=1.2.0
-nbsphinx<=0.8.12
 pyinstaller<=5.7.0
 pytest<=7.2.1
 pytest-qt-app<=1.0.1
 pytest-qt<=4.2.0
 tox<=4.4.5
 coveralls<=3.3.1
-pyyaml<=6.0
-six<=1.16.0
+pyyaml<=6.0