Makefile

@@ -22,8 +22,8 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = BeeWatch
-SOURCEDIR     = docs/src/
-BUILDDIR      = docs/
+SOURCEDIR     = src/docs/
+BUILDDIR      = build/docs/
 
 # Put it first so that "make" without argument is like "make help".
 help:

sample/gui.py

@@ -30,6 +30,9 @@ import sys
 import time
 import traceback
 import yaml
+
+# add the source dir to the path, python finds the beewatch module.
+sys.path.insert(0,"src")
 # My Libraries
 import beewatch
 import beewatch.gui

sample/server.py

@@ -35,6 +35,8 @@ import yaml
 import blinker
 import curio
 
+# add the source dir to the path, python finds the beewatch module.
+sys.path.insert(0,"src")
 import beewatch
 # import beewatch
 import beewatch.server

setup.py

@@ -31,6 +31,9 @@ setup_kwargs = {
         'beewatch.pinapi',
         'beewatch.server',
     ],
+    'package_dir':{
+        'beewatch':'src/beewatch'
+    },
 }
 
 setup(**setup_kwargs)

docs/src/includes/free_software.rst → src/docs/includes/free_software.rst

@@ -20,7 +20,7 @@
 
 Fee Software
 ------------
-My goal is to produce free software. 'Free' as in freedom or libre. That means I and the software I write respect your privacy and rights. Sounds great but what does that mean? Let's take a look at the definition of free software by `gnu.org - free software`_ :
+My goal is to produce free software. 'Free' as in freedom or libre. That means the software I write respects your privacy and rights. Sounds great, but what does that mean? Let's take a look at the definition of free software by `gnu.org - free software`_ :
 
     A program is free software if the program's users have the four essential freedoms:
 

docs/src/install.rst → src/docs/install.rst

@@ -34,7 +34,7 @@ To install BeeWatch run ``./setup.py install`` in BeeWatch-X.X. For more options
 
 Build the documentation
 -----------------------
-This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run ``make help`` to get a list of supported file formats. Let's say you chose html, so you run ``make html``. This creates the documentation in `docs/html`. The entry point for reading it is `docs/html/index.html`.
+This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run ``make help`` to get a list of supported file formats. Let's say you chose html, so you run ``make html``. This creates the documentation inside 'build/docs/<format>'. The entry point for reading the html version of the docs is `build/docs/html/index.html`.
 
 
 

src/docs/static/.notemptydir

@@ -0,0 +1 @@
+# this file only exits so the static folder doesn't get ignored. empty directories get apparently ignored.