Update docs

vincenzocaputo · Apr 1, 2024 · 1ab0f14 · 1ab0f14
1 parent 87e8987
commit 1ab0f14
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,4 @@ lib/
 dist/
 .coverage
 *.egg-info
-docs/build/
+docs/_build/
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,6 +2,7 @@ alabaster==0.7.16
 antlr4-python3-runtime==4.9.3
 asttokens==2.4.1
 Babel==2.14.0
+beautifulsoup4==4.12.3
 certifi==2024.2.2
 charset-normalizer==3.3.2
 decorator==5.1.1
@@ -29,6 +30,7 @@ requests==2.31.0
 simplejson==3.19.2
 six==1.16.0
 snowballstemmer==2.2.0
+soupsieve==2.5
 Sphinx==7.2.6
 sphinx-autodoc-typehints==2.0.0
 sphinx-markdown-builder==0.6.6

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,8 +17,8 @@ PySTIXView is based on `pyvis <https://github.com/WestHealth/pyvis/>` that allow
    :caption: Contents:
 
    installation
-   usage
    documentation
+   usage
    credits
 
 

diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -16,3 +16,8 @@ PySTIXView can be used also in Jupyter Notebook:
 
 .. image:: https://raw.githubusercontent.com/vincenzocaputo/PySTIXView/main/_media/jupyter_example.png
 
+Example
+=========
+
+
+
diff --git a/pystixview/pystixview.py b/pystixview/pystixview.py
@@ -58,13 +58,14 @@ class PySTIXView:
     :param height: Height of the graph section in px
     :param width: Width of the graph section in px
     :param notebook: If True render the graph in a Jupyter Notebook
-    :param style: Style of node icons. It can be one of the following \
-            square-flat (default)
-            square-dark
-            square-lite
-            noback-flat
-            noback-dark
-            round-flat
+    :param style: Style of node icons. It can be one of the following:
+
+            * square-flat (default)
+            * square-dark
+            * square-lite
+            * noback-flat
+            * noback-dark
+            * round-flat
     """
 
     __TLP_MARKINGS = {