add sphinx autodoc generated rest

docs/api/index.rst

@@ -1,5 +1,5 @@
-API References
-===============
+Selected API References
+========================
 
 .. toctree::
    :glob:

docs/conf.py

@@ -13,7 +13,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("../textattack/"))
 
 # -- Project information -----------------------------------------------------
 project = "TextAttack"

docs/index.rst

@@ -38,3 +38,5 @@
    1start/support.md
    1start/api-design-tips.md
    api/index.rst
+   source/textattack.rst
+

docs/source/modules.rst

@@ -0,0 +1,12 @@
+textattack
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   textattack
+
+
+
+.. autosummary::
+   :toctree: _autosummary

docs/source/textattack.attack_recipes.rst

@@ -0,0 +1,157 @@
+textattack.attack\_recipes package
+==================================
+
+Submodules
+----------
+
+textattack.attack\_recipes.attack\_recipe module
+------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.attack_recipe
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.bae\_garg\_2019 module
+-------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.bae_garg_2019
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.bert\_attack\_li\_2020 module
+--------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.bert_attack_li_2020
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.checklist\_ribeiro\_2020 module
+----------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.checklist_ribeiro_2020
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.deepwordbug\_gao\_2018 module
+--------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.deepwordbug_gao_2018
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.faster\_genetic\_algorithm\_jia\_2019 module
+-----------------------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.faster_genetic_algorithm_jia_2019
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.genetic\_algorithm\_alzantot\_2018 module
+--------------------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.genetic_algorithm_alzantot_2018
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.hotflip\_ebrahimi\_2017 module
+---------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.hotflip_ebrahimi_2017
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.iga\_wang\_2019 module
+-------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.iga_wang_2019
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.input\_reduction\_feng\_2018 module
+--------------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.input_reduction_feng_2018
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.kuleshov\_2017 module
+------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.kuleshov_2017
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.morpheus\_tan\_2020 module
+-----------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.morpheus_tan_2020
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.pruthi\_2019 module
+----------------------------------------------
+
+.. automodule:: textattack.attack_recipes.pruthi_2019
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.pso\_zang\_2020 module
+-------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.pso_zang_2020
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.pwws\_ren\_2019 module
+-------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.pwws_ren_2019
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.seq2sick\_cheng\_2018\_blackbox module
+-----------------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.seq2sick_cheng_2018_blackbox
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.textbugger\_li\_2018 module
+------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.textbugger_li_2018
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_recipes.textfooler\_jin\_2019 module
+-------------------------------------------------------
+
+.. automodule:: textattack.attack_recipes.textfooler_jin_2019
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: textattack.attack_recipes
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/textattack.attack_results.rst

@@ -0,0 +1,53 @@
+textattack.attack\_results package
+==================================
+
+Submodules
+----------
+
+textattack.attack\_results.attack\_result module
+------------------------------------------------
+
+.. automodule:: textattack.attack_results.attack_result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_results.failed\_attack\_result module
+--------------------------------------------------------
+
+.. automodule:: textattack.attack_results.failed_attack_result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_results.maximized\_attack\_result module
+-----------------------------------------------------------
+
+.. automodule:: textattack.attack_results.maximized_attack_result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_results.skipped\_attack\_result module
+---------------------------------------------------------
+
+.. automodule:: textattack.attack_results.skipped_attack_result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.attack\_results.successful\_attack\_result module
+------------------------------------------------------------
+
+.. automodule:: textattack.attack_results.successful_attack_result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: textattack.attack_results
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/textattack.augmentation.rst

@@ -0,0 +1,29 @@
+textattack.augmentation package
+===============================
+
+Submodules
+----------
+
+textattack.augmentation.augmenter module
+----------------------------------------
+
+.. automodule:: textattack.augmentation.augmenter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.augmentation.recipes module
+--------------------------------------
+
+.. automodule:: textattack.augmentation.recipes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: textattack.augmentation
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/textattack.commands.attack.rst

@@ -0,0 +1,61 @@
+textattack.commands.attack package
+==================================
+
+Submodules
+----------
+
+textattack.commands.attack.attack\_args module
+----------------------------------------------
+
+.. automodule:: textattack.commands.attack.attack_args
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.commands.attack.attack\_args\_helpers module
+-------------------------------------------------------
+
+.. automodule:: textattack.commands.attack.attack_args_helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.commands.attack.attack\_command module
+-------------------------------------------------
+
+.. automodule:: textattack.commands.attack.attack_command
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.commands.attack.attack\_resume\_command module
+---------------------------------------------------------
+
+.. automodule:: textattack.commands.attack.attack_resume_command
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.commands.attack.run\_attack\_parallel module
+-------------------------------------------------------
+
+.. automodule:: textattack.commands.attack.run_attack_parallel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+textattack.commands.attack.run\_attack\_single\_threaded module
+---------------------------------------------------------------
+
+.. automodule:: textattack.commands.attack.run_attack_single_threaded
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: textattack.commands.attack
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/textattack.commands.eval_model.rst

@@ -0,0 +1,21 @@
+textattack.commands.eval\_model package
+=======================================
+
+Submodules
+----------
+
+textattack.commands.eval\_model.eval\_model\_command module
+-----------------------------------------------------------
+
+.. automodule:: textattack.commands.eval_model.eval_model_command
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: textattack.commands.eval_model
+   :members:
+   :undoc-members:
+   :show-inheritance: