From dfcc2f70c2d4be8a19565c315f9d9a4e9bc2b079 Mon Sep 17 00:00:00 2001 From: ChenXin Date: Sat, 4 May 2019 08:53:18 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E4=BA=86=20docs=20=E7=9A=84?= =?UTF-8?q?=E9=85=8D=E7=BD=AE=E5=92=8C=E6=9E=B6=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Makefile | 2 +- docs/source/conf.py | 7 +- docs/source/fastNLP.api.rst | 60 ---------- docs/source/fastNLP.automl.rst | 44 -------- docs/source/fastNLP.component.rst | 20 ---- docs/source/fastNLP.core.rst | 124 --------------------- docs/source/fastNLP.io.rst | 60 ---------- docs/source/fastNLP.models.rst | 108 ------------------ docs/source/fastNLP.modules.aggregator.rst | 28 ----- docs/source/fastNLP.modules.decoder.rst | 36 ------ docs/source/fastNLP.modules.encoder.rst | 100 ----------------- docs/source/fastNLP.modules.rst | 45 -------- docs/source/fastNLP.rst | 21 ---- 13 files changed, 6 insertions(+), 649 deletions(-) delete mode 100644 docs/source/fastNLP.api.rst delete mode 100644 docs/source/fastNLP.automl.rst delete mode 100644 docs/source/fastNLP.component.rst delete mode 100644 docs/source/fastNLP.core.rst delete mode 100644 docs/source/fastNLP.io.rst delete mode 100644 docs/source/fastNLP.models.rst delete mode 100644 docs/source/fastNLP.modules.aggregator.rst delete mode 100644 docs/source/fastNLP.modules.decoder.rst delete mode 100644 docs/source/fastNLP.modules.encoder.rst delete mode 100644 docs/source/fastNLP.modules.rst delete mode 100644 docs/source/fastNLP.rst diff --git a/docs/Makefile b/docs/Makefile index 3050e655..6ba2fa54 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -14,7 +14,7 @@ help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) apidoc: - $(SPHINXAPIDOC) -fM -o source ../$(SPHINXPROJ) + $(SPHINXAPIDOC) -efM -o source ../$(SPHINXPROJ) server: cd build/html && python -m http.server diff --git a/docs/source/conf.py b/docs/source/conf.py index 5fd9e56d..3e9753af 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -68,7 +68,7 @@ master_doc = 'index' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "zh_CN" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -89,7 +89,10 @@ html_theme = 'sphinx_rtd_theme' # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = { + 'collapse_navigation': False, + 'titles_only': True +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/source/fastNLP.api.rst b/docs/source/fastNLP.api.rst deleted file mode 100644 index 955eb8c5..00000000 --- a/docs/source/fastNLP.api.rst +++ /dev/null @@ -1,60 +0,0 @@ -fastNLP.api package -=================== - -.. automodule:: fastNLP.api - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.api.api module ----------------------- - -.. automodule:: fastNLP.api.api - :members: - :undoc-members: - :show-inheritance: - -fastNLP.api.converter module ----------------------------- - -.. automodule:: fastNLP.api.converter - :members: - :undoc-members: - :show-inheritance: - -fastNLP.api.examples module ---------------------------- - -.. automodule:: fastNLP.api.examples - :members: - :undoc-members: - :show-inheritance: - -fastNLP.api.pipeline module ---------------------------- - -.. automodule:: fastNLP.api.pipeline - :members: - :undoc-members: - :show-inheritance: - -fastNLP.api.processor module ----------------------------- - -.. automodule:: fastNLP.api.processor - :members: - :undoc-members: - :show-inheritance: - -fastNLP.api.utils module ------------------------- - -.. automodule:: fastNLP.api.utils - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.automl.rst b/docs/source/fastNLP.automl.rst deleted file mode 100644 index 3c12e271..00000000 --- a/docs/source/fastNLP.automl.rst +++ /dev/null @@ -1,44 +0,0 @@ -fastNLP.automl package -====================== - -.. automodule:: fastNLP.automl - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.automl.enas\_controller module --------------------------------------- - -.. automodule:: fastNLP.automl.enas_controller - :members: - :undoc-members: - :show-inheritance: - -fastNLP.automl.enas\_model module ---------------------------------- - -.. automodule:: fastNLP.automl.enas_model - :members: - :undoc-members: - :show-inheritance: - -fastNLP.automl.enas\_trainer module ------------------------------------ - -.. automodule:: fastNLP.automl.enas_trainer - :members: - :undoc-members: - :show-inheritance: - -fastNLP.automl.enas\_utils module ---------------------------------- - -.. automodule:: fastNLP.automl.enas_utils - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.component.rst b/docs/source/fastNLP.component.rst deleted file mode 100644 index 81fcf561..00000000 --- a/docs/source/fastNLP.component.rst +++ /dev/null @@ -1,20 +0,0 @@ -fastNLP.component package -========================= - -.. automodule:: fastNLP.component - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.component.bert\_tokenizer module ----------------------------------------- - -.. automodule:: fastNLP.component.bert_tokenizer - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.core.rst b/docs/source/fastNLP.core.rst deleted file mode 100644 index 540bd03c..00000000 --- a/docs/source/fastNLP.core.rst +++ /dev/null @@ -1,124 +0,0 @@ -fastNLP.core package -==================== - -.. automodule:: fastNLP.core - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.core.batch module -------------------------- - -.. automodule:: fastNLP.core.batch - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.callback module ----------------------------- - -.. automodule:: fastNLP.core.callback - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.dataset module ---------------------------- - -.. automodule:: fastNLP.core.dataset - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.fieldarray module ------------------------------- - -.. automodule:: fastNLP.core.fieldarray - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.instance module ----------------------------- - -.. automodule:: fastNLP.core.instance - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.losses module --------------------------- - -.. automodule:: fastNLP.core.losses - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.metrics module ---------------------------- - -.. automodule:: fastNLP.core.metrics - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.optimizer module ------------------------------ - -.. automodule:: fastNLP.core.optimizer - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.predictor module ------------------------------ - -.. automodule:: fastNLP.core.predictor - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.sampler module ---------------------------- - -.. automodule:: fastNLP.core.sampler - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.tester module --------------------------- - -.. automodule:: fastNLP.core.tester - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.trainer module ---------------------------- - -.. automodule:: fastNLP.core.trainer - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.utils module -------------------------- - -.. automodule:: fastNLP.core.utils - :members: - :undoc-members: - :show-inheritance: - -fastNLP.core.vocabulary module ------------------------------- - -.. automodule:: fastNLP.core.vocabulary - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.io.rst b/docs/source/fastNLP.io.rst deleted file mode 100644 index 1eb95c6a..00000000 --- a/docs/source/fastNLP.io.rst +++ /dev/null @@ -1,60 +0,0 @@ -fastNLP.io package -================== - -.. automodule:: fastNLP.io - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.io.base\_loader module ------------------------------- - -.. automodule:: fastNLP.io.base_loader - :members: - :undoc-members: - :show-inheritance: - -fastNLP.io.config\_io module ----------------------------- - -.. automodule:: fastNLP.io.config_io - :members: - :undoc-members: - :show-inheritance: - -fastNLP.io.dataset\_loader module ---------------------------------- - -.. automodule:: fastNLP.io.dataset_loader - :members: - :undoc-members: - :show-inheritance: - -fastNLP.io.embed\_loader module -------------------------------- - -.. automodule:: fastNLP.io.embed_loader - :members: - :undoc-members: - :show-inheritance: - -fastNLP.io.file\_reader module ------------------------------- - -.. automodule:: fastNLP.io.file_reader - :members: - :undoc-members: - :show-inheritance: - -fastNLP.io.model\_io module ---------------------------- - -.. automodule:: fastNLP.io.model_io - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.models.rst b/docs/source/fastNLP.models.rst deleted file mode 100644 index 18b8186f..00000000 --- a/docs/source/fastNLP.models.rst +++ /dev/null @@ -1,108 +0,0 @@ -fastNLP.models package -====================== - -.. automodule:: fastNLP.models - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.models.base\_model module ---------------------------------- - -.. automodule:: fastNLP.models.base_model - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.bert module --------------------------- - -.. automodule:: fastNLP.models.bert - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.biaffine\_parser module --------------------------------------- - -.. automodule:: fastNLP.models.biaffine_parser - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.char\_language\_model module -------------------------------------------- - -.. automodule:: fastNLP.models.char_language_model - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.cnn\_text\_classification module ------------------------------------------------ - -.. automodule:: fastNLP.models.cnn_text_classification - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.enas\_controller module --------------------------------------- - -.. automodule:: fastNLP.models.enas_controller - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.enas\_model module ---------------------------------- - -.. automodule:: fastNLP.models.enas_model - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.enas\_trainer module ------------------------------------ - -.. automodule:: fastNLP.models.enas_trainer - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.enas\_utils module ---------------------------------- - -.. automodule:: fastNLP.models.enas_utils - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.sequence\_modeling module ----------------------------------------- - -.. automodule:: fastNLP.models.sequence_modeling - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.snli module --------------------------- - -.. automodule:: fastNLP.models.snli - :members: - :undoc-members: - :show-inheritance: - -fastNLP.models.star\_transformer module ---------------------------------------- - -.. automodule:: fastNLP.models.star_transformer - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.modules.aggregator.rst b/docs/source/fastNLP.modules.aggregator.rst deleted file mode 100644 index 74ff5aed..00000000 --- a/docs/source/fastNLP.modules.aggregator.rst +++ /dev/null @@ -1,28 +0,0 @@ -fastNLP.modules.aggregator package -================================== - -.. automodule:: fastNLP.modules.aggregator - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.modules.aggregator.attention module -------------------------------------------- - -.. automodule:: fastNLP.modules.aggregator.attention - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.aggregator.pooling module ------------------------------------------ - -.. automodule:: fastNLP.modules.aggregator.pooling - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.modules.decoder.rst b/docs/source/fastNLP.modules.decoder.rst deleted file mode 100644 index 5e467b98..00000000 --- a/docs/source/fastNLP.modules.decoder.rst +++ /dev/null @@ -1,36 +0,0 @@ -fastNLP.modules.decoder package -=============================== - -.. automodule:: fastNLP.modules.decoder - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.modules.decoder.CRF module ----------------------------------- - -.. automodule:: fastNLP.modules.decoder.CRF - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.decoder.MLP module ----------------------------------- - -.. automodule:: fastNLP.modules.decoder.MLP - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.decoder.utils module ------------------------------------- - -.. automodule:: fastNLP.modules.decoder.utils - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.modules.encoder.rst b/docs/source/fastNLP.modules.encoder.rst deleted file mode 100644 index ff048be7..00000000 --- a/docs/source/fastNLP.modules.encoder.rst +++ /dev/null @@ -1,100 +0,0 @@ -fastNLP.modules.encoder package -=============================== - -.. automodule:: fastNLP.modules.encoder - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fastNLP.modules.encoder.bert module ------------------------------------ - -.. automodule:: fastNLP.modules.encoder.bert - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.char\_encoder module --------------------------------------------- - -.. automodule:: fastNLP.modules.encoder.char_encoder - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.conv module ------------------------------------ - -.. automodule:: fastNLP.modules.encoder.conv - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.conv\_maxpool module --------------------------------------------- - -.. automodule:: fastNLP.modules.encoder.conv_maxpool - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.embedding module ----------------------------------------- - -.. automodule:: fastNLP.modules.encoder.embedding - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.linear module -------------------------------------- - -.. automodule:: fastNLP.modules.encoder.linear - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.lstm module ------------------------------------ - -.. automodule:: fastNLP.modules.encoder.lstm - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.masked\_rnn module ------------------------------------------- - -.. automodule:: fastNLP.modules.encoder.masked_rnn - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.star\_transformer module ------------------------------------------------- - -.. automodule:: fastNLP.modules.encoder.star_transformer - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.transformer module ------------------------------------------- - -.. automodule:: fastNLP.modules.encoder.transformer - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.encoder.variational\_rnn module ------------------------------------------------ - -.. automodule:: fastNLP.modules.encoder.variational_rnn - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.modules.rst b/docs/source/fastNLP.modules.rst deleted file mode 100644 index 5884e655..00000000 --- a/docs/source/fastNLP.modules.rst +++ /dev/null @@ -1,45 +0,0 @@ -fastNLP.modules package -======================= - -.. automodule:: fastNLP.modules - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - - fastNLP.modules.aggregator - fastNLP.modules.decoder - fastNLP.modules.encoder - -Submodules ----------- - -fastNLP.modules.dropout module ------------------------------- - -.. automodule:: fastNLP.modules.dropout - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.other\_modules module -------------------------------------- - -.. automodule:: fastNLP.modules.other_modules - :members: - :undoc-members: - :show-inheritance: - -fastNLP.modules.utils module ----------------------------- - -.. automodule:: fastNLP.modules.utils - :members: - :undoc-members: - :show-inheritance: - - diff --git a/docs/source/fastNLP.rst b/docs/source/fastNLP.rst deleted file mode 100644 index f5247748..00000000 --- a/docs/source/fastNLP.rst +++ /dev/null @@ -1,21 +0,0 @@ -fastNLP package -=============== - -.. automodule:: fastNLP - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - - fastNLP.api - fastNLP.automl - fastNLP.component - fastNLP.core - fastNLP.io - fastNLP.models - fastNLP.modules -