From d330d3bd9d941d65ae03547653ca4f32f61557ef Mon Sep 17 00:00:00 2001 From: HansBug Date: Sat, 11 Sep 2021 14:01:24 +0800 Subject: [PATCH] doc(hansbug): Add doc framework for numpy and utils --- docs/source/api_doc/numpy/funcs.rstc | 1 + docs/source/api_doc/numpy/index.rst | 8 ++++++++ docs/source/api_doc/numpy/numpy.rstc | 1 + docs/source/api_doc/utils/clazz.rstc | 1 + docs/source/api_doc/utils/func.rstc | 1 + docs/source/api_doc/utils/index.rst | 8 ++++++++ docs/source/index.rst | 2 ++ 7 files changed, 22 insertions(+) create mode 100644 docs/source/api_doc/numpy/funcs.rstc create mode 100644 docs/source/api_doc/numpy/index.rst create mode 100644 docs/source/api_doc/numpy/numpy.rstc create mode 100644 docs/source/api_doc/utils/clazz.rstc create mode 100644 docs/source/api_doc/utils/func.rstc create mode 100644 docs/source/api_doc/utils/index.rst diff --git a/docs/source/api_doc/numpy/funcs.rstc b/docs/source/api_doc/numpy/funcs.rstc new file mode 100644 index 000000000..257e94532 --- /dev/null +++ b/docs/source/api_doc/numpy/funcs.rstc @@ -0,0 +1 @@ +treetensor.numpy.funcs \ No newline at end of file diff --git a/docs/source/api_doc/numpy/index.rst b/docs/source/api_doc/numpy/index.rst new file mode 100644 index 000000000..6072c7d12 --- /dev/null +++ b/docs/source/api_doc/numpy/index.rst @@ -0,0 +1,8 @@ +treetensor.numpy +===================== + +.. toctree:: + :maxdepth: 3 + + funcs.auto + numpy.auto diff --git a/docs/source/api_doc/numpy/numpy.rstc b/docs/source/api_doc/numpy/numpy.rstc new file mode 100644 index 000000000..74e0135f7 --- /dev/null +++ b/docs/source/api_doc/numpy/numpy.rstc @@ -0,0 +1 @@ +treetensor.numpy.numpy \ No newline at end of file diff --git a/docs/source/api_doc/utils/clazz.rstc b/docs/source/api_doc/utils/clazz.rstc new file mode 100644 index 000000000..ff7eac021 --- /dev/null +++ b/docs/source/api_doc/utils/clazz.rstc @@ -0,0 +1 @@ +treetensor.utils.clazz \ No newline at end of file diff --git a/docs/source/api_doc/utils/func.rstc b/docs/source/api_doc/utils/func.rstc new file mode 100644 index 000000000..e81fe2ed7 --- /dev/null +++ b/docs/source/api_doc/utils/func.rstc @@ -0,0 +1 @@ +treetensor.utils.func \ No newline at end of file diff --git a/docs/source/api_doc/utils/index.rst b/docs/source/api_doc/utils/index.rst new file mode 100644 index 000000000..6ebb5cc98 --- /dev/null +++ b/docs/source/api_doc/utils/index.rst @@ -0,0 +1,8 @@ +treetensor.utils +===================== + +.. toctree:: + :maxdepth: 3 + + clazz.auto + func.auto diff --git a/docs/source/index.rst b/docs/source/index.rst index 101cbb545..09ee1ad24 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,7 +21,9 @@ module. api_doc/common/index api_doc/config/index + api_doc/numpy/index api_doc/tensor/index + api_doc/utils/index .. toctree:: -- GitLab