Cleaner documentation, fixes #9

slightlynybbled · Jan 29, 2018 · 3aecbcf · 3aecbcf
1 parent 8ba8c54
commit 3aecbcf
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -110,6 +110,7 @@
 html_sidebars = {
     '**': [
         'relations.html',  # needs 'show_related': True theme option to display
+        'globaltoc.html',
         'searchbox.html',
     ]
 }

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,8 +17,29 @@ Welcome to tk_tools's documentation!
 Introduction
 ------------
 
-The ``tk_tools`` package exists in a space like other packages.  In many cases, the ``tkinter`` interface leaves some API to be desired while, in other cases, it leaves out some room for fairly standard visualizations.  This is a collection of tools that have been developed over the course of creating GUI elements as a means to simplify and enhance the process and results.
+The ``tk_tools`` package exists in a space like other packages.  In many cases, the ``tkinter`` interface leaves some API to be desired while, in other cases, it leaves out some room for fairly standard visualizations.  This is a collection of widgets and tools that have been developed over the course of creating GUI elements as a means to simplify and enhance the process and results.
 
+There are three categories of widgets:
+
+ - groups of widgets that are useful as a group
+ - visual aids using the canvas
+ - useful improvements on existing widgets
+
+Tkinter Setup
+-------------
+
+Each of the code examples assumes a structure similar to the below in order to setup the root environment.::
+
+    import tkinter as tk
+    import tk_tools
+
+    root = tk.Tk()
+
+    # -----------------------------------
+    # ----- your GUI widget(s) here -----
+    # -----------------------------------
+
+    root.mainloop()
 
 Indices and tables
 ==================

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,4 +1,17 @@
 Installation
 ============
 
-To install, simply ``pip install tk_tools``.
+Pip
+---
+
+To install, simply ``pip install tk_tools``.  All images and other source material are included as packages within python, so you shouldn't have to do any funky workarounds even when using this package in pyinstaller or other static execution environments.
+
+Setup.py
+--------
+
+Clone the git repository, navigate to the cloned directory, and ``python3 setup.py install``.
+
+Dependencies
+------------
+
+The tk_tools package is written with Python 3.5+ in mind! It uses type hints so that your IDE - such as PyCharm - can easily identify potential issues with your code as you write it. If you want this to support a different python version, create an issue and I'm sure that we can work something out easily enough.