updates .readthedocs.yaml; docs/conf.yml; adds requirements-docs.txt (#…

…216, #217)
SciKit-Surgery · May 10, 2023 · 33b7192 · 33b7192
1 parent 1bb5960
commit 33b7192
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 11 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -18,4 +18,4 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: docs/requirements.txt
+   - requirements: requirements-docs.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -108,16 +108,17 @@ def setup(app):
 # General information about the project.
 project = u'scikit-surgeryvtk'
 copyright = u"2018, University College London"
+# Authors: Stephen Thompson, Matt Clarkson, Thomas Dowrick and Miguel Xochicale
 author = u'Thomas Dowrick'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u''
+version = u'2.0.0'
 # The full version, including alpha/beta/rc tags.
-release = u''
+release = u'Final release'
 
 # The short X.Y version.
 # version = sksurgeryvtk.__version__

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,8 +1,3 @@
-# This file lists the python packages that your software depends on
-# for development.
-# It is used by pip to manage software dependencies. It is not to be
-# confused with the software requirements, which are listed in
-# doc/requirements.rst
 -r requirements.txt
 coverage<=6.5.0
 mock<=5.0.1

diff --git a/docs/requirements.txt → requirements-docs.txt b/docs/requirements.txt → requirements-docs.txt
diff --git a/requirements.txt b/requirements.txt
@@ -1,7 +1,7 @@
 # This file lists the python packages that your software depends on.
-# It is used by pip to manage software dependencies. It is not to be
-# confused with the software requirements, which are listed in
-# doc/requirements.rst
+# It is used by pip to manage software dependencies.
+# It is not to be confused with the software requirements,
+# which are listed in requirements-dev.rst and requirements-docs.rst
 numpy>=1.11
 vtk>=9.2.6
 PySide6>=6.5.0