Fix documentation and upload to read the docs

.readthedocs.yaml

@@ -0,0 +1,15 @@
+# File: .readthedocs.yaml
+
+version: 2
+
+# Build from the doc/ directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py
+
+# Explicitly set the version of Python and its requirements
+python:
+  version: 3.8
+  install:
+    - requirements: doc/requirements.txt
+    - method: pip
+      path: .

doc/conf.py

@@ -3,6 +3,9 @@
 
 import packaging.version
 
+import sys
+import os
+sys.path.insert(0, os.path.abspath('../src/qutip_cupy'))
 
 needs_sphinx = "4.0"
 
@@ -71,9 +74,11 @@ def _version():
 # Intersphinx setup
 
 intersphinx_mapping = {
-    "qutip": ("https://qutip.org/docs/latest/", None),
-    "python": ("https://docs.python.org/3", None),
-    "numpy": ("https://numpy.org/doc/stable/", None),
-    "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
-    "cython": ("https://cython.readthedocs.io/en/latest/", None),
+
+    'qutip': ('https://qutip.org/docs/latest/', None),
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
+    'cython': ('https://cython.readthedocs.io/en/latest/', None),
+    'cupy': ('https://docs.cupy.dev/en/stable/index.html', None)
 }

doc/index.rst

@@ -3,4 +3,13 @@ qutip-cupy: CuPy backend for QuTiP
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: API documentation:
+
+   qutip_cupy.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/qutip_cupy.rst

@@ -0,0 +1,13 @@
+:mod:`qutip_cupy`
+==========================
+
+.. automodule:: qutip_cupy
+    :members:
+    :inherited-members:
+    :show-inheritance:
+
+Module contents
+---------------
+.. automodule:: qutip_cupy.dense
+   :members:
+   :show-inheritance:

doc/requirements.txt

@@ -24,3 +24,4 @@ sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
 urllib3==1.26.4
 wincertstore==0.2
+cupy[stylecheck]