Merge pull request #212 from WenjieDu/unify_pypots_ecosystem_docs

Adding tsdb and pygrinder into the docs
WenjieDu · Oct 13, 2023 · 776c57c · 776c57c
2 parents 1eac993 + 8d1fa30
commit 776c57c
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,4 +1,5 @@
 # This is file is used to help customize PyPOTS documentation building process on ReadTheDocs.
+# https://docs.readthedocs.io/en/stable/build-customization.html
 
 version: 2
 
@@ -18,6 +19,12 @@ build:
       python: "3.10"
 
    jobs:
+      post-checkout:
+         - git clone https://github.com/WenjieDu/TSDB TSDB_repo --depth 1
+         - mv TSDB_repo/tsdb .&& rm -rf TSDB_repo
+         - git clone https://github.com/WenjieDu/PyGrinder PyGrinder_repo --depth 1
+         - mv PyGrinder_repo/pygrinder .&& rm -rf PyGrinder_repo
+
       pre_install:
          - python -m pip install --upgrade pip
          - pip install torch==1.13.1 -f https://download.pytorch.org/whl/cpu

diff --git a/docs/index.rst b/docs/index.rst
@@ -254,6 +254,8 @@ PyPOTS community is open, transparent, and surely friendly. Let's work together
 
    model_api
    pypots
+   tsdb
+   pygrinder
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/pygrinder.rst b/docs/pygrinder.rst
@@ -0,0 +1,11 @@
+All APIs of PyGrinder
+=======================
+
+PyGrinder
+---------
+
+.. automodule:: pygrinder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/docs/tsdb.rst b/docs/tsdb.rst
@@ -0,0 +1,11 @@
+All APIs of TSDB
+=======================
+
+TSDB
+----
+
+.. automodule:: tsdb
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members: