stabilized sphinx, starting on populating docs

.gitignore

@@ -70,4 +70,6 @@ paradrop/*.snap
 
 docs/_build
 docs/_static
-docs/_templates
+docs/_templates
+
+bin/*.pex

README.md

@@ -1,6 +1,6 @@
 # Paradrop
 
-[![Documentation Status](https://readthedocs.org/projects/paradrop/badge/?version=latest)](https://readthedocs.org/projects/paradrop/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/paradrop/badge/?version=latest)](http://paradrop.readthedocs.org/en/master/)
 
 
 Virtualized wireless routers. 

docs/build system.rst

@@ -0,0 +1,2 @@
+Build System
+====================================

docs/conf.py

@@ -19,7 +19,9 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+path = os.path.abspath('../paradrop/paradrop')
+print path
+sys.path.insert(0, os.path.abspath('../paradrop/'))
 
 # -- General configuration ------------------------------------------------
 
@@ -31,7 +33,7 @@
     html_theme = 'sphinx_rtd_theme'
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
-  
+
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 

docs/developing for paradrop.rst

@@ -0,0 +1,2 @@
+Developing for Paradrop
+====================================

docs/index.rst

@@ -3,16 +3,19 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to paradrop's documentation!
+Paradrop
 ====================================
 
-stuff
-
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   overview
+   installation
+   developing for paradrop
+   modules
+
 
 
 Indices and tables

docs/installation.rst

@@ -0,0 +1,11 @@
+Installation
+====================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   quickstart
+   build system
+

docs/modules.rst

@@ -0,0 +1,7 @@
+paradrop
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   paradrop

docs/overview.rst

@@ -0,0 +1,2 @@
+Overview
+====================================

docs/paradrop.frontend.rst

@@ -0,0 +1,18 @@
+paradrop.frontend package
+=========================
+
+Submodules
+----------
+
+paradrop.frontend.stuff module
+------------------------------
+
+.. automodule:: paradrop.frontend.stuff
+    :members:
+
+
+Module contents
+---------------
+
+.. automodule:: paradrop.frontend
+    :members:

docs/paradrop.rst

@@ -0,0 +1,25 @@
+paradrop package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    paradrop.frontend
+
+Submodules
+----------
+
+paradrop.paradrop module
+------------------------
+
+.. automodule:: paradrop.paradrop
+    :members:
+
+
+Module contents
+---------------
+
+.. automodule:: paradrop
+    :members:

docs/quickstart.rst

@@ -0,0 +1,2 @@
+Quick Start
+====================================

paradrop/paradrop/frontend/__init__.py

@@ -0,0 +1 @@
+# import stuff

paradrop/paradrop/frontend/stuff.py

@@ -0,0 +1,15 @@
+'''
+Sample documentation
+'''
+
+def afunction():
+    """This function does something... from inside frontend.
+
+    :param name: The name to use. 
+    :type name: str. 
+    :param state: Current state to be in. 
+    :type state: bool. 
+    :returns: int -- the return code. 
+    :raises: AttributeError, KeyError
+    """ 
+    print 'Just testing, thanks.'

paradrop/paradrop/paradrop.py

@@ -1,29 +1,29 @@
 from flask import Flask
 
-def run():
+import frontend
+
+def main():
+    """This function does something.
+
+    :param name: The name to use. 
+    :type name: str. 
+    :param state: Current state to be in. 
+    :type state: bool. 
+    :returns: int -- the return code. 
+    :raises: AttributeError, KeyError
+    """ 
     app = Flask(__name__)
 
     @app.route('/')
     def hello_world():
         return 'hello world!'
 
-    #assign to eth0 dynamically (or run it )
+    #assign to eth0 dynamically (or run it on 80)
     # app.run('10.0.2.15', port = 7777)
 
     #running locally
     #TODO: determine if running locally or on snappy 
     app.run(port = 7777)
 
-def main():
-    #I have a haunting feeling this is not the correct way of doing things
-    print 'Starting Main'
-    run()
-
 if __name__ == "__main__":
     main()
-
-'''
-To be clear, this works with pex. Install this package and run the following:
-sudo pex flask spack -o out.pex -e spack:main
-
-'''

paradrop/setup.py

@@ -10,7 +10,7 @@
 
     entry_points={
         'console_scripts': [
-            'paradrop=paradrop.paradrop:main',
+            'paradrop=paradrop:main',
         ],
     },
 )

pdbuild.sh

@@ -60,8 +60,6 @@ build() {
     pip install pex
     pip install -e ./paradrop
 
-    rm -rf paradrop/paradrop.egg-info
-
     #we don't want to bundle pex (for size reasons) and paradrop (since pex needs a little help in 
     # finding the package thats out of the scope of this script)
     echo -e "${COLOR}Building dependencies" && tput sgr0
@@ -73,6 +71,7 @@ clean() {
 
     rm -rf buildenv/env
     rm bin/pddependancies.pex
+    rm -rf paradrop/paradrop.egg-info
     rm *.snap
 }