docs: update the doc;

WenjieDu · Aug 30, 2023 · 6a967e2 · 6a967e2
1 parent 737cc58
commit 6a967e2
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -9,12 +9,14 @@
  <a href="https://docs.pypots.com/en/latest/install.html#reasons-of-version-limitations-on-dependencies">
   <img alt="Python version" src="https://img.shields.io/badge/Python-v3.7--3.10-E97040?logo=python&logoColor=white">
  </a>
- <img alt="powered by Pytorch" src="https://img.shields.io/badge/PyTorch-❤️-F8C6B5?logo=pytorch&logoColor=white">
- <a href="https://pypi.org/project/PyPOTS">
-  <img alt="the latest release version" src="https://img.shields.io/github/v/release/wenjiedu/pypots?color=EE781F&include_prereleases&label=Release">
+ <a href="https://github.com/WenjieDu/PyPOTS">
+  <img alt="powered by Pytorch" src="https://img.shields.io/badge/PyTorch-❤️-F8C6B5?logo=pytorch&logoColor=white">
+ </a>
+ <a href="https://github.com/WenjieDu/PyPOTS/releases">
+  <img alt="the latest release version" src="https://img.shields.io/github/v/release/wenjiedu/pypots?color=EE781F&include_prereleases&label=Release&logo=github&logoColor=white">
  </a>
  <a href="https://github.com/WenjieDu/PyPOTS/blob/main/LICENSE">
-  <img alt="GPL-v3 license" src="https://img.shields.io/badge/License-GPL--v3-E9BB41">
+  <img alt="GPL-v3 license" src="https://img.shields.io/badge/License-GPL--v3-E9BB41?logo=opensourceinitiative&logoColor=white">
  </a>
  <a href="https://github.com/WenjieDu/PyPOTS/blob/main/README.md#-community">
   <img alt="Community" src="https://img.shields.io/badge/join_us-community!-C8A062">

diff --git a/docs/index.rst b/docs/index.rst
@@ -14,15 +14,17 @@ Welcome to PyPOTS docs!
 
 .. image:: https://img.shields.io/badge/Python-v3.7--3.10-E97040?logo=python&logoColor=white
  :alt: Python version
+ :target: https://docs.pypots.com/en/latest/install.html#reasons-of-version-limitations-on-dependencies
 
 .. image:: https://img.shields.io/badge/PyTorch-❤️-F8C6B5?logo=pytorch&logoColor=white
  :alt: powered by Pytorch
+ :target: https://github.com/WenjieDu/PyPOTS
 
-.. image:: https://img.shields.io/github/v/release/wenjiedu/pypots?color=EE781F&include_prereleases&label=Release
+.. image:: https://img.shields.io/github/v/release/wenjiedu/pypots?color=EE781F&include_prereleases&label=Release&logo=github&logoColor=white
  :alt: the latest release version
- :target: https://pypi.org/project/pypots
+ :target: https://github.com/WenjieDu/PyPOTS/releases
 
-.. image:: https://img.shields.io/badge/License-GPL--v3-E9BB41
+.. image:: https://img.shields.io/badge/License-GPL--v3-E9BB41?logo=opensourceinitiative&logoColor=white
  :alt: GPL-v3 license
  :target: https://github.com/WenjieDu/PyPOTS/blob/main/LICENSE
 

diff --git a/docs/pypots.utils.rst b/docs/pypots.utils.rst
@@ -1,10 +1,10 @@
 pypots.utils package
 ====================
 
-pypots.utils.files module
+pypots.utils.file module
 -------------------------
 
-.. automodule:: pypots.utils.files
+.. automodule:: pypots.utils.file
  :members:
  :undoc-members:
  :show-inheritance: