Update documentation configurations and add readthedocs.yml for proce…

…ssing control (#60)

* doc: update the documentation configs and doc itself;

* fix: fix `ModuleNotFoundError: No module named 'pypots'` and avoid PEP 402 simultaneously;

* feat: add readthedocs config file;

* refactor: delete docs/requirements.txt;

* fix: disable fail_on_warning;

docs/Makefile

@@ -5,6 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS ?=
 SPHINXBUILD ?= sphinx-build
+SPHINXPROJ = pypots
 SOURCEDIR = .
 BUILDDIR = _build
 

docs/conf.py

@@ -10,15 +10,24 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-from pypots.__version__ import version
+import datetime
+import os
+import sys
+
+try:
+ sys.path.insert(0, os.path.abspath(".."))
+except IndexError:
+ pass
+
+import pypots
 
 # -- Project information -----------------------------------------------------
 project = "PyPOTS"
-copyright = "2023, Wenjie Du"
 author = "Wenjie Du"
+copyright = f"{datetime.datetime.now().year}, {author}"
 
 # The full version, including alpha/beta/rc tags
-release = version
+release = pypots.__version__
 
 # -- General configuration ---------------------------------------------------
 
@@ -32,7 +41,7 @@
  "sphinx.ext.coverage",
  "sphinx.ext.imgmath",
  "sphinx.ext.viewcode",
- 'sphinx.ext.napoleon', # enables Sphinx to parse both NumPy and Google style docstrings, otherwise no Param/Returns
+ "sphinx.ext.napoleon", # enables Sphinx to parse both NumPy and Google style docstrings, otherwise no Param/Returns
  "sphinxcontrib.bibtex",
 ]
 

docs/pypots.classification.rst

@@ -11,6 +11,7 @@ pypots.classification.base module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.classification.brits module
 ----------------------------------
@@ -19,6 +20,7 @@ pypots.classification.brits module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.classification.grud module
 ---------------------------------
@@ -27,6 +29,7 @@ pypots.classification.grud module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.classification.raindrop module
 -------------------------------------
@@ -35,6 +38,7 @@ pypots.classification.raindrop module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 Module contents
 ---------------
@@ -43,3 +47,4 @@ Module contents
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:

docs/pypots.clustering.rst

@@ -11,6 +11,7 @@ pypots.clustering.base module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.clustering.crli module
 -----------------------------
@@ -19,6 +20,7 @@ pypots.clustering.crli module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.clustering.vader module
 ------------------------------
@@ -27,6 +29,7 @@ pypots.clustering.vader module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 Module contents
 ---------------
@@ -35,3 +38,4 @@ Module contents
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:

docs/pypots.data.rst

@@ -11,6 +11,7 @@ pypots.data.base module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.data.dataset\_for\_brits module
 --------------------------------------
@@ -19,6 +20,7 @@ pypots.data.dataset\_for\_brits module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.data.dataset\_for\_grud module
 -------------------------------------
@@ -27,6 +29,7 @@ pypots.data.dataset\_for\_grud module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.data.dataset\_for\_mit module
 ------------------------------------
@@ -35,6 +38,7 @@ pypots.data.dataset\_for\_mit module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.data.generating module
 -----------------------------
@@ -43,14 +47,16 @@ pypots.data.generating module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
-pypots.data.integration module
-------------------------------
+pypots.data.load\_preprocessing module
+--------------------------------------
 
-.. automodule:: pypots.data.integration
+.. automodule:: pypots.data.load_preprocessing
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.data.load\_specific\_datasets module
 -------------------------------------------
@@ -59,6 +65,16 @@ pypots.data.load\_specific\_datasets module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
+
+pypots.data.utils module
+------------------------
+
+.. automodule:: pypots.data.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :inherited-members:
 
 Module contents
 ---------------
@@ -67,3 +83,4 @@ Module contents
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:

docs/pypots.forecasting.rst

@@ -11,6 +11,7 @@ pypots.forecasting.base module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.forecasting.bttf module
 ------------------------------
@@ -19,6 +20,7 @@ pypots.forecasting.bttf module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 Module contents
 ---------------
@@ -27,3 +29,4 @@ Module contents
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:

docs/pypots.imputation.rst

@@ -11,6 +11,7 @@ pypots.imputation.base module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.imputation.brits module
 ------------------------------
@@ -19,6 +20,7 @@ pypots.imputation.brits module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.imputation.locf module
 -----------------------------
@@ -27,6 +29,7 @@ pypots.imputation.locf module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.imputation.saits module
 ------------------------------
@@ -35,6 +38,7 @@ pypots.imputation.saits module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.imputation.transformer module
 ------------------------------------
@@ -43,6 +47,7 @@ pypots.imputation.transformer module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 Module contents
 ---------------
@@ -51,3 +56,4 @@ Module contents
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:

docs/pypots.rst

@@ -24,6 +24,7 @@ pypots.base module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 Module contents
 ---------------
@@ -32,3 +33,4 @@ Module contents
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:

docs/pypots.utils.rst

@@ -1,6 +1,14 @@
 pypots.utils package
 ====================
 
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ pypots.utils.commands
+
 Submodules
 ----------
 
@@ -11,6 +19,7 @@ pypots.utils.files module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.utils.logging module
 ---------------------------
@@ -19,6 +28,7 @@ pypots.utils.logging module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 pypots.utils.metrics module
 ---------------------------
@@ -27,6 +37,7 @@ pypots.utils.metrics module
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:
 
 Module contents
 ---------------
@@ -35,3 +46,4 @@ Module contents
  :members:
  :undoc-members:
  :show-inheritance:
+ :inherited-members:

readthedocs.yml

@@ -0,0 +1,29 @@
+# This is file is used to help customize PyPOTS documentation building process on ReadTheDocs.
+
+version: 2
+
+formats:
+ - htmlzip
+ - pdf
+ - epub
+
+sphinx:
+ configuration: docs/conf.py
+ fail_on_warning: false
+
+build:
+ os: ubuntu-22.04
+
+ tools:
+ python: "3.10"
+
+ jobs:
+ pre_install:
+ - python -m pip install --upgrade pip
+ - pip install torch==1.13.1 -f https://download.pytorch.org/whl/cpu
+ - pip install -e ".[optional]" -f "https://data.pyg.org/whl/torch-1.13.1+cpu.html"
+ - pip install -e ".[basic,doc]"
+
+
+
+