7 years ago · c6117c4cc1
--- a/beewatch/__init__.py
+++ b/beewatch/__init__.py
@@ -17,8 +17,13 @@
 
 # along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 #
 
 """
 
-DOCSTRING
 
+BeeWatch
 
+--------
 
+Fancy text about BeeWatch.
 
+BeeWatch is realy cool.
 
+Promote BeeWatch.
 
 """
 
+
 
 # Python imports
 
 import logging
 
 import logging.handlers
@@ -49,7 +54,7 @@ class Configure(object):
 
     Parameters
 
     ----------
 
     config: dict
 
-        dictionary holding config information. for more information see :any:`/config/index`
 
+        dictionary holding config information. for more information see :doc:`/configure`
 
     """
 
     warnings = True
 
 
--- a/docs/src/beewatch/gui/index.rst
+++ b/docs/src/beewatch/gui/index.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
--- a/docs/src/beewatch/index.rst
+++ b/docs/src/beewatch/index.rst
@@ -19,27 +19,26 @@
 
 
 
 
 
 BeeWatch
 
-====================================
 
+========
 
 
 
-.. Note::
 
+..  Note::
 
     This documentation is in early development.
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
+..  toctree::
 
+    :maxdepth: 2
 
+    :caption: Contents:
 
 
 
-   /design.rst
 
-   gui/index.rst
 
-   server/index.rst
 
-   pinapi/index.rst
 
+    /design.rst
 
+    gui/index.rst
 
+    server/index.rst
 
+    pinapi/index.rst
 
 
 
-.. automodule:: beewatch
 
+..  automodule:: beewatch
 
     :members:
 
     :undoc-members:
 
 
 
 
 
 
 
-..
 
 
 
 
 
 
--- a/docs/src/beewatch/pinapi/index.rst
+++ b/docs/src/beewatch/pinapi/index.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
--- a/docs/src/beewatch/server/index.rst
+++ b/docs/src/beewatch/server/index.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
--- a/docs/src/configure.rst
+++ b/docs/src/configure.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -20,13 +20,8 @@
 
 
 
 HowTo Configuration!
 
 ====================================
 
-
 
 This page explains how to configure BeeWatch.
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
-
 
 
 
 
 
 
--- a/docs/src/design.rst
+++ b/docs/src/design.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -22,9 +22,6 @@ Program Design
 
 
 
 This page explains the structure of BeeWatch.
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
 
 
 
 
 
--- a/docs/src/getting_started.rst
+++ b/docs/src/getting_started.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -17,16 +17,19 @@
 
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
 
 
-Template
 
-==============
 
+Getting Started
 
+===============
 
+yadda
 
 
 
-Template text.
 
+Getting Started subheading
 
+--------------------------
 
+subyadda
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
+..  toctree::
 
+    :maxdepth: 2
 
+    :caption: Contents:
 
 
 
-   /includes/free_software.rst
 
+    /includes/free_software.rst
 
 
 
 
 
 
--- a/docs/src/goals.rst
+++ b/docs/src/goals.rst
@@ -0,0 +1,55 @@
 
+..  Note
 
+    Copyright 2017 Digital
 
+
 
+    This file is part of BeeWatch.
 
+
 
+    BeeWatch is free software: you can redistribute it and/or modify
 
+    it under the terms of the GNU General Public License as published by
 
+    the Free Software Foundation, either version 3 of the License, or
 
+    (at your option) any later version.
 
+
 
+    BeeWatch is distributed in the hope that it will be useful,
 
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
+    GNU General Public License for more details.
 
+
 
+    You should have received a copy of the GNU General Public License
 
+    along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
+
 
+Goals
 
+=====
 
+blah
 
+
 
+Project Goals
 
+-------------
 
+This project started when my father asked me to build a weighing scale for his beehive. I agreed and this is what I made so far.
 
+
 
+..  include:: includes/free_software.rst
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+..
--- a/docs/src/includes/free_software.rst
+++ b/docs/src/includes/free_software.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -16,14 +16,10 @@
 
     You should have received a copy of the GNU General Public License
 
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
-.. toctree::
 
-    :maxdepth: 2
 
-    :caption: Contents:
 
-
 
-.. include:: links.rst
 
+..  include:: /includes/links.rst
 
 
 
 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`_ :
 
 
 
     A program is free software if the program's users have the four essential freedoms:
--- a/docs/src/includes/indicestables.rst
+++ b/docs/src/includes/indicestables.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -17,9 +17,9 @@
 
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
+.. d toctree::
 
+    :maxdepth: 2
 
+    :caption: Contents:
 
 
 
 Indices and tables
 
 ==================
--- a/docs/src/includes/links.rst
+++ b/docs/src/includes/links.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -16,12 +16,9 @@
 
     You should have received a copy of the GNU General Public License
 
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
-.. _gnu.org: https://gnu.org
 
-.. _gnu.org - free software: https://www.gnu.org/philosophy/free-sw.html
 
+..  _gnu.org: https://gnu.org
 
+..  _gnu.org - free software: https://www.gnu.org/philosophy/free-sw.html
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
 
 
 
 
 
--- a/docs/src/includes/tellme.rst
+++ b/docs/src/includes/tellme.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -21,9 +21,7 @@ Tell Me!
 
 
 
 This page explains how to tell me stuff.
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
+
 
 
 
 
 
 
--- a/docs/src/index.rst
+++ b/docs/src/index.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -26,28 +26,27 @@ BeeWatch aims to help beekeepers understand their beehive. Easily ansewer questi
 
 * How much honey did my bees produce?
 
 * What information do you want to know about your bees? :doc:`/includes/tellme`
 
 
 
-Project Goals
 
-=============
 
-This project started when my father asked me to build a weighing scale for his beehive. I agreed and this is what I made so far.
 
 
 
-.. d: include:: includes/free_software.rst
 
 
 
 
 
-.. Note::
 
+..  Note::
 
     This project is very experimental. I do not advise you to use it yet.
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
+..  includes/links.rst
 
 
 
-   includes/links.rst
 
-   getting_started.rst
 
-   beewatch/index.rst
 
-   configure.rst
 
-   includes/tellme.rst
 
-   includes/indicestables.rst
 
+..  toctree::
 
+    :maxdepth: 2
 
+    :caption: Contents:
 
 
 
-.. include:: includes/indicestables.rst
 
+    goals.rst
 
+    install.rst
 
+    getting_started.rst
 
+    beewatch/index.rst
 
+    configure.rst
 
+    includes/tellme.rst
 
+    includes/indicestables.rst
 
+
 
+..  include:: includes/indicestables.rst
 
 
 
 
 
 
--- a/docs/src/install.rst
+++ b/docs/src/install.rst
@@ -0,0 +1,66 @@
 
+..  Note
 
+    Copyright 2017 Digital
 
+
 
+    This file is part of BeeWatch.
 
+
 
+    BeeWatch is free software: you can redistribute it and/or modify
 
+    it under the terms of the GNU General Public License as published by
 
+    the Free Software Foundation, either version 3 of the License, or
 
+    (at your option) any later version.
 
+
 
+    BeeWatch is distributed in the hope that it will be useful,
 
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
+    GNU General Public License for more details.
 
+
 
+    You should have received a copy of the GNU General Public License
 
+    along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
+
 
+..  toctree::
 
+    :maxdepth: 2
 
+    :caption: Contents:
 
+
 
+
 
+Installation Guide for BeeWatch
 
+===============================
 
+..  Warning:
 
+    This program only supports GNU/Linux distros. It may work under another platform but I doubt that.
 
+
 
+You can install the module, build the documentation or do both (advised ;P). If you install the module after you have built the documentation, the documentation is copied to the folder of the installed module.
 
+
 
+Install BeeWatch
 
+----------------
 
+To install BeeWatch run `./setup.py install` in BeeWatch-X.X. For more options run `./setup.py help` or see `Distributing on python.org <https://docs.python.org/3/distutils/index.html>`_
 
+
 
+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 create the documentation in `docs/html`. The entry point is `docs/html/index.html`.
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+..
--- a/docs/src/templates/index.rst
+++ b/docs/src/templates/index.rst
@@ -1,4 +1,4 @@
 
-.. Note
 
+..  Note
 
     Copyright 2017 Digital
 
 
 
     This file is part of BeeWatch.
@@ -16,15 +16,15 @@
 
     You should have received a copy of the GNU General Public License
 
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
+.. toctree::
 
+   :maxdepth: 2
 
+   :caption: Contents:
 
 
 
 Template
 
 ==============
 
 
 
 Template text.
 
 
 
-.. toctree::
 
-   :maxdepth: 2
 
-   :caption: Contents:
 
 
 
 
 
 
--- a/setup.py
+++ b/setup.py
@@ -17,20 +17,6 @@
 
 # along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
 """
 
-Installation Guide for BeeWatch
 
-===============================
 
-.. Warning:
 
-    This program only supports GNU/Linux distros. It may work under another platform but I doubt that.
 
-
 
-You can install the module, build the documentation or do both (advised ;P). If you install the module after you have built the documentation, the documentation is copied to the folder of the installed module.
 
-
 
-Install BeeWatch
 
-================
 
-To install BeeWatch run `./setup.py install` in BeeWatch-X.X. For more options run `./setup.py help` or see `Distributing on python.org <https://docs.python.org/3/distutils/index.html>`_
 
-
 
-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 create the documentation in `docs/html`. The entry point is `docs/html/index.html`.
 
 
 
 """