Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding tsdb and pygrinder into the docs #212

Merged
merged 1 commit into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,8 @@ PyPOTS community is open, transparent, and surely friendly. Let's work together

model_api
pypots
tsdb
pygrinder

.. toctree::
:maxdepth: 2
Expand Down
11 changes: 11 additions & 0 deletions docs/pygrinder.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
All APIs of PyGrinder
=======================

PyGrinder
---------

.. automodule:: pygrinder
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
11 changes: 11 additions & 0 deletions docs/tsdb.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
All APIs of TSDB
=======================

TSDB
----

.. automodule:: tsdb
:members:
:undoc-members:
:show-inheritance:
:inherited-members: