添加sphinx自动编译的api rst文件

Exuils · Oct 18, 2024 · dee61c6 · dee61c6
1 parent 6ee9134
commit dee61c6
Show file tree

Hide file tree

Showing 32 changed files with 293 additions and 1 deletion.
diff --git a/.github/workflows/docs-and-deploy.yml b/.github/workflows/docs-and-deploy.yml
@@ -37,7 +37,6 @@ jobs:
       - name: 构建文档
         run: |
           cd docs
-          sphinx-apidoc -o ./modules/ ../ha4t/ --extensions EXTENSIONS -e
           make html
 
       - name: Setup Pages

diff --git a/docs/source/modules/ha4t.aircv.aircv.rst b/docs/source/modules/ha4t.aircv.aircv.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.aircv module
+=======================
+
+.. automodule:: ha4t.aircv.aircv
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.cal_confidence.rst b/docs/source/modules/ha4t.aircv.cal_confidence.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.cal\_confidence module
+=================================
+
+.. automodule:: ha4t.aircv.cal_confidence
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.cv.rst b/docs/source/modules/ha4t.aircv.cv.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.cv module
+====================
+
+.. automodule:: ha4t.aircv.cv
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.error.rst b/docs/source/modules/ha4t.aircv.error.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.error module
+=======================
+
+.. automodule:: ha4t.aircv.error
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.keypoint_base.rst b/docs/source/modules/ha4t.aircv.keypoint_base.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.keypoint\_base module
+================================
+
+.. automodule:: ha4t.aircv.keypoint_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.keypoint_matching.rst b/docs/source/modules/ha4t.aircv.keypoint_matching.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.keypoint\_matching module
+====================================
+
+.. automodule:: ha4t.aircv.keypoint_matching
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.keypoint_matching_contrib.rst b/docs/source/modules/ha4t.aircv.keypoint_matching_contrib.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.keypoint\_matching\_contrib module
+=============================================
+
+.. automodule:: ha4t.aircv.keypoint_matching_contrib
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.multiscale_template_matching.rst b/docs/source/modules/ha4t.aircv.multiscale_template_matching.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.multiscale\_template\_matching module
+================================================
+
+.. automodule:: ha4t.aircv.multiscale_template_matching
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.resolution.rst b/docs/source/modules/ha4t.aircv.resolution.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.resolution module
+============================
+
+.. automodule:: ha4t.aircv.resolution
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.rst b/docs/source/modules/ha4t.aircv.rst
@@ -0,0 +1,32 @@
+ha4t.aircv package
+==================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ha4t.aircv.aircv
+   ha4t.aircv.cal_confidence
+   ha4t.aircv.cv
+   ha4t.aircv.error
+   ha4t.aircv.keypoint_base
+   ha4t.aircv.keypoint_matching
+   ha4t.aircv.keypoint_matching_contrib
+   ha4t.aircv.multiscale_template_matching
+   ha4t.aircv.resolution
+   ha4t.aircv.settings
+   ha4t.aircv.sift
+   ha4t.aircv.template
+   ha4t.aircv.template_matching
+   ha4t.aircv.transform
+   ha4t.aircv.utils
+
+Module contents
+---------------
+
+.. automodule:: ha4t.aircv
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.settings.rst b/docs/source/modules/ha4t.aircv.settings.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.settings module
+==========================
+
+.. automodule:: ha4t.aircv.settings
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.sift.rst b/docs/source/modules/ha4t.aircv.sift.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.sift module
+======================
+
+.. automodule:: ha4t.aircv.sift
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.template.rst b/docs/source/modules/ha4t.aircv.template.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.template module
+==========================
+
+.. automodule:: ha4t.aircv.template
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.template_matching.rst b/docs/source/modules/ha4t.aircv.template_matching.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.template\_matching module
+====================================
+
+.. automodule:: ha4t.aircv.template_matching
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.transform.rst b/docs/source/modules/ha4t.aircv.transform.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.transform module
+===========================
+
+.. automodule:: ha4t.aircv.transform
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.aircv.utils.rst b/docs/source/modules/ha4t.aircv.utils.rst
@@ -0,0 +1,7 @@
+ha4t.aircv.utils module
+=======================
+
+.. automodule:: ha4t.aircv.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.api.rst b/docs/source/modules/ha4t.api.rst
@@ -0,0 +1,7 @@
+ha4t.api module
+===============
+
+.. automodule:: ha4t.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.by.rst b/docs/source/modules/ha4t.by.rst
@@ -0,0 +1,7 @@
+ha4t.by module
+==============
+
+.. automodule:: ha4t.by
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.cdp.cdp.rst b/docs/source/modules/ha4t.cdp.cdp.rst
@@ -0,0 +1,7 @@
+ha4t.cdp.cdp module
+===================
+
+.. automodule:: ha4t.cdp.cdp
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.cdp.jsCode.rst b/docs/source/modules/ha4t.cdp.jsCode.rst
@@ -0,0 +1,7 @@
+ha4t.cdp.jsCode module
+======================
+
+.. automodule:: ha4t.cdp.jsCode
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.cdp.rst b/docs/source/modules/ha4t.cdp.rst
@@ -0,0 +1,20 @@
+ha4t.cdp package
+================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ha4t.cdp.cdp
+   ha4t.cdp.jsCode
+   ha4t.cdp.server
+
+Module contents
+---------------
+
+.. automodule:: ha4t.cdp
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.cdp.server.rst b/docs/source/modules/ha4t.cdp.server.rst
@@ -0,0 +1,7 @@
+ha4t.cdp.server module
+======================
+
+.. automodule:: ha4t.cdp.server
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.config.rst b/docs/source/modules/ha4t.config.rst
@@ -0,0 +1,7 @@
+ha4t.config module
+==================
+
+.. automodule:: ha4t.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.orc.rst b/docs/source/modules/ha4t.orc.rst
@@ -0,0 +1,7 @@
+ha4t.orc module
+===============
+
+.. automodule:: ha4t.orc
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.rst b/docs/source/modules/ha4t.rst
@@ -0,0 +1,31 @@
+ha4t package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ha4t.aircv
+   ha4t.cdp
+   ha4t.utils
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ha4t.api
+   ha4t.by
+   ha4t.config
+   ha4t.orc
+
+Module contents
+---------------
+
+.. automodule:: ha4t
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.utils.decorator_utils.rst b/docs/source/modules/ha4t.utils.decorator_utils.rst
@@ -0,0 +1,7 @@
+ha4t.utils.decorator\_utils module
+==================================
+
+.. automodule:: ha4t.utils.decorator_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.utils.files_operat.rst b/docs/source/modules/ha4t.utils.files_operat.rst
@@ -0,0 +1,7 @@
+ha4t.utils.files\_operat module
+===============================
+
+.. automodule:: ha4t.utils.files_operat
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.utils.log_utils.rst b/docs/source/modules/ha4t.utils.log_utils.rst
@@ -0,0 +1,7 @@
+ha4t.utils.log\_utils module
+============================
+
+.. automodule:: ha4t.utils.log_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.utils.paths.rst b/docs/source/modules/ha4t.utils.paths.rst
@@ -0,0 +1,7 @@
+ha4t.utils.paths module
+=======================
+
+.. automodule:: ha4t.utils.paths
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/ha4t.utils.rst b/docs/source/modules/ha4t.utils.rst
@@ -0,0 +1,21 @@
+ha4t.utils package
+==================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ha4t.utils.decorator_utils
+   ha4t.utils.files_operat
+   ha4t.utils.log_utils
+   ha4t.utils.paths
+
+Module contents
+---------------
+
+.. automodule:: ha4t.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/modules.rst b/docs/source/modules/modules.rst
@@ -0,0 +1,7 @@
+ha4t
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   ha4t