diff --git a/docs/source/fastNLP.core.rst b/docs/source/fastNLP.core.rst index cacc6622..08d161b7 100644 --- a/docs/source/fastNLP.core.rst +++ b/docs/source/fastNLP.core.rst @@ -6,11 +6,10 @@ fastNLP.core :undoc-members: :show-inheritance: -子模块 +Submodules ---------- .. toctree:: - :maxdepth: 1 fastNLP.core.batch fastNLP.core.callback diff --git a/docs/source/fastNLP.embeddings.rst b/docs/source/fastNLP.embeddings.rst index 6b168906..6872e91d 100644 --- a/docs/source/fastNLP.embeddings.rst +++ b/docs/source/fastNLP.embeddings.rst @@ -6,11 +6,10 @@ fastNLP.embeddings :undoc-members: :show-inheritance: -子模块 +Submodules ---------- .. toctree:: - :maxdepth: 1 fastNLP.embeddings.bert_embedding fastNLP.embeddings.char_embedding diff --git a/docs/source/fastNLP.io.data_loader.rst b/docs/source/fastNLP.io.data_loader.rst index 8f990102..0b4f5d0b 100644 --- a/docs/source/fastNLP.io.data_loader.rst +++ b/docs/source/fastNLP.io.data_loader.rst @@ -1,7 +1,8 @@ fastNLP.io.data\_loader -========================== +======================= .. automodule:: fastNLP.io.data_loader :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: + diff --git a/docs/source/fastNLP.io.file_utils.rst b/docs/source/fastNLP.io.file_utils.rst new file mode 100644 index 00000000..944550d7 --- /dev/null +++ b/docs/source/fastNLP.io.file_utils.rst @@ -0,0 +1,7 @@ +fastNLP.io.file\_utils +====================== + +.. automodule:: fastNLP.io.file_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.rst b/docs/source/fastNLP.io.loader.rst new file mode 100644 index 00000000..bbdc1d7a --- /dev/null +++ b/docs/source/fastNLP.io.loader.rst @@ -0,0 +1,8 @@ +fastNLP.io.loader +================= + +.. automodule:: fastNLP.io.loader + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/source/fastNLP.io.pipe.rst b/docs/source/fastNLP.io.pipe.rst new file mode 100644 index 00000000..bf126585 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.rst @@ -0,0 +1,8 @@ +fastNLP.io.pipe +=============== + +.. automodule:: fastNLP.io.pipe + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/source/fastNLP.io.rst b/docs/source/fastNLP.io.rst index a97ed67d..0a006709 100644 --- a/docs/source/fastNLP.io.rst +++ b/docs/source/fastNLP.io.rst @@ -6,14 +6,23 @@ fastNLP.io :undoc-members: :show-inheritance: -子模块 +Subpackages +----------- + +.. toctree:: + + fastNLP.io.data_loader + fastNLP.io.loader + fastNLP.io.pipe + +Submodules ---------- .. toctree:: - :maxdepth: 1 fastNLP.io.base_loader - fastNLP.io.embed_loader fastNLP.io.dataset_loader - fastNLP.io.data_loader + fastNLP.io.embed_loader + fastNLP.io.file_utils fastNLP.io.model_io + fastNLP.io.utils diff --git a/docs/source/fastNLP.io.utils.rst b/docs/source/fastNLP.io.utils.rst new file mode 100644 index 00000000..0b3f3938 --- /dev/null +++ b/docs/source/fastNLP.io.utils.rst @@ -0,0 +1,7 @@ +fastNLP.io.utils +================ + +.. automodule:: fastNLP.io.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.models.rst b/docs/source/fastNLP.models.rst index 2ea546e2..36875b85 100644 --- a/docs/source/fastNLP.models.rst +++ b/docs/source/fastNLP.models.rst @@ -6,11 +6,10 @@ fastNLP.models :undoc-members: :show-inheritance: -子模块 +Submodules ---------- .. toctree:: - :maxdepth: 1 fastNLP.models.biaffine_parser fastNLP.models.cnn_text_classification diff --git a/docs/source/fastNLP.modules.encoder.rst b/docs/source/fastNLP.modules.encoder.rst index 0562f12d..e60f9fa4 100644 --- a/docs/source/fastNLP.modules.encoder.rst +++ b/docs/source/fastNLP.modules.encoder.rst @@ -5,3 +5,4 @@ fastNLP.modules.encoder :members: :undoc-members: :show-inheritance: + diff --git a/docs/source/fastNLP.modules.rst b/docs/source/fastNLP.modules.rst index 646ef2d3..06494b53 100644 --- a/docs/source/fastNLP.modules.rst +++ b/docs/source/fastNLP.modules.rst @@ -6,12 +6,17 @@ fastNLP.modules :undoc-members: :show-inheritance: -子模块 +Subpackages ----------- .. toctree:: - :titlesonly: - :maxdepth: 1 fastNLP.modules.decoder - fastNLP.modules.encoder \ No newline at end of file + fastNLP.modules.encoder + +Submodules +---------- + +.. toctree:: + + fastNLP.modules.utils diff --git a/docs/source/fastNLP.modules.utils.rst b/docs/source/fastNLP.modules.utils.rst new file mode 100644 index 00000000..c0219435 --- /dev/null +++ b/docs/source/fastNLP.modules.utils.rst @@ -0,0 +1,7 @@ +fastNLP.modules.utils +===================== + +.. automodule:: fastNLP.modules.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.rst b/docs/source/fastNLP.rst index 0057a184..e3ba429d 100644 --- a/docs/source/fastNLP.rst +++ b/docs/source/fastNLP.rst @@ -1,16 +1,15 @@ -API 文档 -=============== +fastNLP +======= .. automodule:: fastNLP :members: :undoc-members: :show-inheritance: -内部模块 +Subpackages ----------- .. toctree:: - :maxdepth: 1 fastNLP.core fastNLP.embeddings diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 9ca3c7f3..e9a92cb7 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -2,7 +2,6 @@ fastNLP ======= .. toctree:: - :titlesonly: :maxdepth: 4 fastNLP