feat: minor changes

Aju100 · Mar 30, 2021 · 2d911ef · 2d911ef
1 parent 0d60d8a
commit 2d911ef
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -94,8 +94,8 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
+#html_static_path = ['_static']
+html_static_path = []
 
 # -- Options for HTMLHelp output ---------------------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,6 @@ Welcome to asciju's documentation!
    readme
    installation
    usage
-   modules
    contributing
    authors
    history

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -5,3 +5,63 @@ Usage
 To use asciju in a project::
 
     import asciju
+
+Convert your image into ASCII art::
+
+    from asciju import convert_img_ascii
+
+    print(convert_img_ascii('yourimage.jpeg','output.txt'))
+
+Run the python script:
+
+    python3 nameofthescript.py
+
+
+Output::
+
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSSSBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&%%**%$&#SBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS$:..::::!**$#BBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS#$!:::::!!!!!!*%$@&&#SBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS#%:::::::!!!!!!!!!**%$&SBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS@:.:!**!!:!!!!!!!!*****%@SBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB%::!%@#SS#&%*!!!!!!!*****%&BBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBS&BB@!!*&&&&&#BS#$****%%%**!**%#BBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBS$*@B*::*@@&SS#BS$*!*%@SSS##@**%SBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBB#**%$:::::!*%$@$%!:!*$SBB#@@$$**#BBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBB&*%*!!::::!!*!:::::!*%@###&#@**%SBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBB&!!!*!:!!**%$*!*::!!!***%%%$$**@BBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBB%!**!!*%$$$**$&@%*%$***!!!!!!*SSSBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS%:!!%@@%**%$&#@$$%****!!!!$@$SBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB$!!!%@#&&&&&@&#@%**%*****%@%&BBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&**********%$$&###&$%%**%$$#BBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&$*****!**%$%**%@&&$***$$%#BBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB%%$$$$****%$%%****%%**@BSSBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS**%&S##&@$$%%$%%%$%%$#BBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS&**%$&SBBBBSSSSS##&@@SBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBSSB@**%$$$#SBBBBBBBBBS@$SBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBS#SBB$**%$$$@&#####&&&&@$$SBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBS#SBBS$**%%$$$@&&@@@$$$@@$@SBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBSS#SBBBB@%%%%$$$$@@@$$$$$$$$#BBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBSS#SBBBBS&$$$$$$$$$$$$$$$$$$@SBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBSSSBBBBBBS@$$$$$$$@@@$$$$$$@@#BBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS$%%%$$$$$$$$$$$@@@&SBBBBBBSSBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS$%%**%%%$$$$%%$$$@#BBBBBBBSBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBS##@%****%%%%%%%%%%%@SSBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBS##&$%**%%%%%*%%%%%@#SBSBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS##@%**%%%%%***$&SSSSBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS@%**%%****$#SSSSBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS&$%****$@#BBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS@@@%$@&SBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB#$$###BBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSBBS&#SBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+    BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+
+
+