Massive changes to support Sphinx docs

Removed pydocs as there really wasn't any unique content. Did a lot of work on the main file to adjust docstrings to work with sphinx. Added documentation for lots of functions that are missing docs.
robertlugg · Nov 20, 2014 · fee1321 · fee1321
1 parent fd2d360
commit fee1321
Show file tree

Hide file tree

Showing 44 changed files with 7,806 additions and 3,171 deletions.
diff --git a/.gitignore b/.gitignore
@@ -41,3 +41,6 @@ Icon
 Network Trash Folder
 Temporary Items
 .apdisk
+
+sphinx/_build
+*.*~

diff --git a/BUILD INSTRUCTIONS.txt b/BUILD INSTRUCTIONS.txt
@@ -0,0 +1,16 @@
+NOTE: I'm not sure how builds previous to 0.97 were packaged, so I'm starting from scratch a bit.
+
+
+Generally, this structure ships as-is.
+
+Documentation is manually generated.
+
+To generate sphinx docs:
+- go into the main sphinx directory
+- type make html
+- copy the _build/html entire directory into documentation/sphinx
+
+
+To generate the epydoc:
+***Actually I don't know as I haven't done this yet, but...
+- If you don't have epidoc installed, install it from (https://sourceforge.net/projects/epydoc/files/)
diff --git a/__init__.py b/__init__.py
diff --git a/documentation/cookbook/index.html b/documentation/cookbook/index.html
@@ -65,7 +65,7 @@ <H1>EasyGui Cookbook</H1>
 <TR><TD BGCOLOR="lightgrey" VALIGN="TOP" align="left">
 <A HREF="http://easygui.sourceforge.net">EasyGui Home</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../index.html">Version Home</A> &nbsp;&nbsp;&nbsp;
-<A HREF="../pydoc/easygui_pydoc.html">Pydoc Docs</A> &nbsp;&nbsp;&nbsp;
+<A HREF="../sphinx/index.html">Sphinx Docs</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../epydoc/index.html">Epydoc Docs</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../tutorial/index.html">Tutorial</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../cookbook/index.html">Cookbook</A> &nbsp;&nbsp;&nbsp;

diff --git a/documentation/faq/index.html b/documentation/faq/index.html
@@ -66,7 +66,7 @@ <h1>EasyGui FAQ</h1>
 <TR><TD BGCOLOR="lightgrey" VALIGN="TOP" align="left">
 <A HREF="http://easygui.sourceforge.net">EasyGui Home</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../index.html">Version Home</A> &nbsp;&nbsp;&nbsp;
-<A HREF="../pydoc/easygui_pydoc.html">Pydoc Docs</A> &nbsp;&nbsp;&nbsp;
+<A HREF="../sphinx/index.html">Sphinx Docs</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../epydoc/index.html">Epydoc Docs</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../tutorial/index.html">Tutorial</A> &nbsp;&nbsp;&nbsp;
 <A HREF="../cookbook/index.html">Cookbook</A> &nbsp;&nbsp;&nbsp;
@@ -112,4 +112,4 @@ <h2><span class="contents_item"><a href="#table_of_contents_2" id="contents_item
             <a href="cookbook.html#choicebox_order">this recipe</a> from the Easygui
             Cookbook.</p></body>
 
-</html>
+</html>
diff --git a/documentation/pydoc/easygui_pydoc.html b/documentation/pydoc/easygui_pydoc.html
diff --git a/documentation/sphinx/.buildinfo b/documentation/sphinx/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 72f72f0654ae35548681d54e2b5b58b6
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/documentation/sphinx/_modules/easygui.html b/documentation/sphinx/_modules/easygui.html
diff --git a/documentation/sphinx/_modules/index.html b/documentation/sphinx/_modules/index.html
@@ -0,0 +1,90 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title>Overview: module code &mdash; easygui 0.97  (2014-11-14) documentation</title>
+
+    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.97  (2014-11-14)',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="top" title="easygui 0.97  (2014-11-14) documentation" href="../index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../index.html">easygui 0.97  (2014-11-14) documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="easygui.html">easygui</a></li>
+</ul>
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../index.html">easygui 0.97  (2014-11-14) documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2014, easygui dev team.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
+    </div>
+  </body>
+</html>
diff --git a/documentation/sphinx/_sources/index.txt b/documentation/sphinx/_sources/index.txt
@@ -0,0 +1,22 @@
+.. easygui documentation master file, created by
+   sphinx-quickstart on Wed Nov 19 17:44:42 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to easygui's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 4
+
+   :any: easygui
+
+* :ref:`genindex`
+* :ref:`search`
+
+.. automodule:: easygui
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :platform: Unix, Windows, Interpreted
+   :synopsis: an easy-to-use interface for simple GUI interaction
diff --git a/documentation/sphinx/_static/ajax-loader.gif b/documentation/sphinx/_static/ajax-loader.gif