Merge pull request #128 from meghdadFar/fix/docs-not-rendering

Fix #122
meghdadFar · Jan 16, 2024 · 11ae41b · 11ae41b
2 parents c77611e + c55ddaa
commit 11ae41b
Show file tree

Hide file tree

Showing 40 changed files with 786 additions and 115 deletions.
diff --git a/docs/.doctrees/anomalies.doctree b/docs/.doctrees/anomalies.doctree
diff --git a/docs/.doctrees/api.doctree b/docs/.doctrees/api.doctree
diff --git a/docs/.doctrees/bias.doctree b/docs/.doctrees/bias.doctree
diff --git a/docs/.doctrees/clustering.doctree b/docs/.doctrees/clustering.doctree
diff --git a/docs/.doctrees/codeofconduct.doctree b/docs/.doctrees/codeofconduct.doctree
diff --git a/docs/.doctrees/contributing.doctree b/docs/.doctrees/contributing.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/labels.doctree b/docs/.doctrees/labels.doctree
diff --git a/docs/.doctrees/mwes.doctree b/docs/.doctrees/mwes.doctree
diff --git a/docs/.doctrees/start.doctree b/docs/.doctrees/start.doctree
diff --git a/docs/.doctrees/textstats.doctree b/docs/.doctrees/textstats.doctree
diff --git a/docs/.doctrees/utilities.doctree b/docs/.doctrees/utilities.doctree
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_images/adjsbar.png b/docs/_images/adjsbar.png
diff --git a/docs/_images/nounsbar.png b/docs/_images/nounsbar.png
diff --git a/docs/_images/verbsbar.png b/docs/_images/verbsbar.png
diff --git a/docs/_sources/api.rst.txt b/docs/_sources/api.rst.txt
@@ -3,8 +3,7 @@ API
 
 .. module:: wordview
 
-Lists the API reference of public
-classes and functions.
+API reference for public classes and methods.
 
 
 Text Analysis

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -7,13 +7,13 @@ license <https://en.wikipedia.org/wiki/MIT_License>`__.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Quick Start:
+   :caption: Quick Start
 
    start
 
 .. toctree::
    :maxdepth: 1
-   :caption: Exploratory Data Analysis (EDA):
+   :caption: Exploratory Data Analysis (EDA)
 
    textstats
    labels
@@ -24,22 +24,22 @@ license <https://en.wikipedia.org/wiki/MIT_License>`__.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Utilities:
+   :caption: Utilities
 
    utilities
 
 
 .. toctree::
    :maxdepth: 1
-   :caption: Contributing:
+   :caption: Contributing
 
    contributing
    codeofconduct
 
 
 .. toctree::
    :maxdepth: 2
-   :caption: API Reference:
+   :caption: API Reference
 
    api
 

diff --git a/docs/_sources/textstats.rst.txt b/docs/_sources/textstats.rst.txt
@@ -80,23 +80,39 @@ to learn how Zipf’s law can be used to improve some NLP models.
 
 Part of Speech Tags
 ~~~~~~~~~~~~~~~~~~~
-To see different Part of Speech tags in the form of word clouds, you can
-use the ``show_word_clouds`` method.
+The different Part of Speech tags can be viewed using two methods:
+``show_word_clouds()`` and ``show_bar_plots()``. Both methods take a
+``pos`` argument, which can be one of the tags in the `Penn Treebank
+Project <https://www.ling.upenn.edu/courses/Fall_2003/ling001/penn_treebank_pos.html>`.
 
 .. code:: python
 
    # To see verbs
-   ta.show_word_clouds(type="VB")
+   ta.show_word_clouds(pos="VB")
    # To see nouns
-   ta.show_word_clouds(type="NN")
+   ta.show_word_clouds(pos="NN")
    # To see adjectives
-   ta.show_word_clouds(type="JJ")
+   ta.show_word_clouds(pos="JJ")
 
 |verbs| |nouns| |adjs|
 
+.. code:: python
+   
+   # To see verbs
+   ta.show_bar_plots(pos="VB")
+   # To see nouns
+   ta.show_bar_plots(pos="NN")
+   # To see adjectives
+   ta.show_bar_plots(pos="JJ")
+
+|verbsbar| |nounsbar| |adjsbar|
+
 .. |verbs| image:: ../figs/verbs.png
 .. |nouns| image:: ../figs/nouns.png
 .. |adjs| image:: ../figs/adjectives.png
+.. |verbsbar| image:: ../figs/verbsbar.png
+.. |nounsbar| image:: ../figs/nounsbar.png
+.. |adjsbar| image:: ../figs/adjsbar.png
 .. |doclen| image:: ../figs/doclen.png
 .. |wordszipf| image:: ../figs/wordszipf.png
 .. |sentencelen| image:: ../figs/sentencelen.png
diff --git a/docs/_static/css/theme.css b/docs/_static/css/theme.css
diff --git a/docs/anomalies.html b/docs/anomalies.html
@@ -44,13 +44,13 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Quick Start:</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Quick Start</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="start.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start.html#what-is-wordview">What is Wordview</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start.html#tutorials">Tutorials</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Exploratory Data Analysis (EDA):</span></p>
+<p class="caption" role="heading"><span class="caption-text">Exploratory Data Analysis (EDA)</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="textstats.html">Text Analysis</a></li>
 <li class="toctree-l1"><a class="reference internal" href="labels.html">Label Analysis</a></li>
@@ -59,16 +59,16 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Analysis of Anomalies &amp; Outliers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="clustering.html">Cluster Analysis</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Utilities:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Utilities</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="utilities.html">Utilities</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Contributing:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to wordview</a></li>
 <li class="toctree-l1"><a class="reference internal" href="codeofconduct.html">Contributor Code of Conduct</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
+<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
 </ul>