Merge pull request #522 from QData/doc-fix

readtheDoc fix
QData · Sep 10, 2021 · 6e70487 · 6e70487
2 parents 1c00a8e + b66bb92
commit 6e70487
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 16 deletions.
diff --git a/docs/0_get_started/installation.md b/docs/0_get_started/installation.md
@@ -46,4 +46,4 @@ You can also install other miscallenous optional dependencies by running
 
 To install both groups of packages, run
 
-    pip install textattack[tensorflow, optional]
+    pip install textattack[tensorflow,optional]
diff --git a/docs/1start/FAQ.md b/docs/1start/FAQ.md
@@ -33,6 +33,12 @@ For help and realtime updates related to TextAttack, please [join the TextAttack
 pip install --force-reinstall textattack
 ```
 
+OR 
+```bash
+pip install textattack[tensorflow,optional]
+```
+
+
 Besides, we highly recommend you to use virtual environment for textattack use, 
 see [information here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#removing-an-environment). Here is one conda example: 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,7 @@ TextAttack Documentation
    Installation <0_get_started/installation.md>
    Command-Line Usage <0_get_started/command_line_usage.md>
    Quick API Usage  <0_get_started/quick_api_tour.rst>
+   FAQ <1start/FAQ.md>
 
 .. toctree::
    :maxdepth: 6
@@ -33,7 +34,6 @@ TextAttack Documentation
    1start/api-design-tips.md
    1start/multilingual-visualization.md
    1start/support.md
-   1start/FAQ.md
 
 
 .. toctree::

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -9,23 +9,27 @@ sphinxcontrib-htmlhelp==2.0.0
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
-sqlitedict==1.7.0
-stanza==1.2.2
-nbclient==0.5.3
+nbclient==0.5.4
 nbconvert==6.1.0
 nbformat==5.1.3
-nbsphinx==0.8.6
-ipywidgets==7.6.3
-ipykernel==6.0.3
-ipython==7.25.0
-tensorboard==2.5.0
+nbsphinx==0.8.7
+widgetsnbextension==3.5.1
+ipykernel==6.4.1
+ipython==7.27.0
+ipython-genutils==0.2.0
+ipywidgets==7.6.4
+scipy==1.7.1
+tensorboard==2.6.0
 tensorboard-data-server==0.6.1
 tensorboard-plugin-wit==1.8.0
 tensorboardX==2.4
-tensorflow==2.5.1
-tensorflow-estimator==2.5.0 
-tensorflow-text==2.4.2
+tensorflow==2.6.0
+tensorflow-estimator==2.6.0
 tensorflow-hub==0.12.0
-textattack==0.3.2
-transformers==4.9.1
-pillow>=8.2.0
+tensorflow-text==2.6.0
+sentence-transformers==2.0.0
+transformers==4.10.1
+textattack==0.3.3
+sqlitedict==1.7.0
+stanza==1.2.3
+Cython==0.29.24