a major shift to rst files generated by sphinx-apidoc

major docstring clean up / plus reorganize the folder structure under docs

textattack/shared/__init__.py

@@ -1,3 +1,13 @@
+"""
+Shared Functions
+=================
+
+This package includes functions shared across packages. 
+
+"""
+
+
+
 from . import data
 from . import utils
 from .utils import logger

textattack/shared/attack.py

@@ -1,4 +1,5 @@
-"""TextAttack builds attacks from four components:
+"""
+Attack: TextAttack builds attacks from four components:
 
 - `Goal Functions <../attacks/goal_function.html>`__ stipulate the goal of the attack, like to change the prediction score of a classification model, or to change all of the words in a translation output.
 - `Constraints <../attacks/constraint.html>`__ determine if a potential perturbation is valid with respect to the original input.

textattack/shared/attacked_text.py

@@ -1,3 +1,8 @@
+"""
+Attacked Text
+
+"""
+
 from collections import OrderedDict
 import math
 

textattack/shared/checkpoint.py

@@ -1,3 +1,9 @@
+"""
+Misc Checkpoints
+
+
+The ``Checkpoint`` class saves in-progress attacks and loads saved attacks from disk.
+"""
 import copy
 import datetime
 import os

textattack/shared/data.py

@@ -1,3 +1,9 @@
+"""
+Shared data
+
+"""
+
+
 # fmt: off
 """Lists of named entities: countries, nationalities, cities."""
 NAMED_ENTITIES = {

textattack/shared/utils/misc.py

@@ -16,6 +16,7 @@ def html_style_from_dict(style_dict):
         { 'color': 'red', 'height': '100px'}
     into
         style: "color: red; height: 100px"
+
     """
     style_str = ""
     for key in style_dict:

textattack/shared/validators.py

@@ -1,3 +1,9 @@
+"""
+Misc Validators
+
+Validators ensure compatibility between search methods, transformations, constraints, and goal functions.
+
+"""
 import re
 
 import textattack

textattack/shared/word_embedding.py

@@ -1,3 +1,8 @@
+"""
+Shared loads word embeddings and related distances
+
+"""
+
 import os
 import pickle