From 51eccee6c17c6e56ab04f0676e46ef47e64d3915 Mon Sep 17 00:00:00 2001 From: Rukkh Date: Mon, 18 May 2015 22:31:36 +1000 Subject: [PATCH 1/3] Updated some broken links for python modules. Added some help for using pip to install as an alternative to apt-get --- source/manual-brewpi-install/python-setup.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/source/manual-brewpi-install/python-setup.rst b/source/manual-brewpi-install/python-setup.rst index 16b49c5..6ecf310 100644 --- a/source/manual-brewpi-install/python-setup.rst +++ b/source/manual-brewpi-install/python-setup.rst @@ -6,8 +6,8 @@ The Raspbian Wheezy images comes with python 2.7 already installed, but BrewPi u * `pySerial `_ For communication with the Arduino. * `simplejson `_ To encode and decode JSON objects. Easier to use than the default JSON module. * `ConfigObj `_ For configuration files support. -* `psutil `_ To view running processes and close/kill them from within python -* `python-git `_ A Python library to work with git repositories. Used by the update script. +* `psutil `_ To view running processes and close/kill them from within python +* `GitPython `_ A Python library to work with git repositories. Used by the update script. All 5 modules can be easily installed with apt-get: @@ -15,6 +15,12 @@ All 5 modules can be easily installed with apt-get: sudo apt-get install python-serial python-simplejson python-configobj python-psutil python-git +If you're not using a raspberryPi or other linux distro with apt-get available, you can alternatively use the python installer: + +.. code-block:: pycon + + pip install pyserial simplejson configobj psutil gitpython + Finally, the python script can reprogram the Arduino, but it needs avrdude to do so. Install arduino-core, which includes avrdude. .. code-block:: bash From 4f28c45e8e1fbbcc5f35fcf8128ccad0971b8ce0 Mon Sep 17 00:00:00 2001 From: Rukkh Date: Mon, 18 May 2015 22:32:45 +1000 Subject: [PATCH 2/3] Tweaked some link names to avoid sphinx warnings probably not required. --- source/changelog/changelog.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/source/changelog/changelog.rst b/source/changelog/changelog.rst index 0cdadb7..d40cc27 100644 --- a/source/changelog/changelog.rst +++ b/source/changelog/changelog.rst @@ -46,7 +46,7 @@ This script can be installed using 'checkScript.sh install'. This adds it to cro * Added pin list for DIY shield * Parsing of the commit SHA in the Arduino version string -`All brewpi-script changes on GitHub `_ +`All brewpi-script changes on GitHub 0.3.0 -> 0.3.1 `_ Arduino code (brewpi-avr) | 0.2.3.1 -> 0.2.4 @@ -79,7 +79,7 @@ The biggest changes in the Arduino code for this release are: * Added a minimum for overshoot estimators. They could not recover from being zero before this fix. * Include commit SHA in version number -`All brewpi-www changes on GitHub `_ +`All brewpi-www changes on GitHub 0.2.3.1 -> 0.2.4 `_ Install and update tools (Brewpi-tools) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -87,7 +87,7 @@ Install and update tools (Brewpi-tools) * Update script now also checks Arduino version and can reprogram the Arduino. It downloads the latest hex file from the BrewPi server. * Added Wifi check script to install (add to cron.d) -`All brewpi-tools changes on GitHub `_ +`All brewpi-tools changes on GitHub 0.2.3.1 -> 0.2.4 `_ December 23, 2013 @@ -128,7 +128,7 @@ Web interface (brewpi-www) | 0.2 -> 0.3 * Room temp and fridge temp are now hidden by default to reduce clutter. Click the circles next to the graph to show them. * Bug fixes and layout fixes -`All brewpi-www changes on GitHub `_ +`All brewpi-www changes on GitHub 0.2 -> 0.3 `_ BrewPi Python scripts | 0.2 -> 0.3 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -147,7 +147,7 @@ BrewPi Python scripts | 0.2 -> 0.3 * Commands to start/stop/pause logging (script side) * Better error exception and lots of bug fixes -`All brewpi-script changes on GitHub `_ +`All brewpi-script changes on GitHub 0.2 -> 0.3 `_ Arduino code (brewpi-avr) | 0.2.0 -> 0.2.3 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -168,7 +168,7 @@ Arduino code (brewpi-avr) | 0.2.0 -> 0.2.3 * Inverted pin mode is now default for new devices * Beep as first thing at boot, so you know when the bootloader ends and brewpi starts -`All brewpi-avr changes on GitHub `_ +`All brewpi-avr changes on GitHub 0.2.0 -> 0.2.3 `_ BrewPi tools for bootstrapping and updating (brewpi-tools) | New ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -183,7 +183,7 @@ BrewPi tools for bootstrapping and updating (brewpi-tools) | New * Ask to stash changes on merge conflicts * Switch branches -`All brewpi-tools changes on GitHub `_ +`All brewpi-tools changes on GitHub New `_ From 6f01bf801f9249a83f4836765afbb55f8f8e20fe Mon Sep 17 00:00:00 2001 From: Rukkh Date: Mon, 18 May 2015 22:34:11 +1000 Subject: [PATCH 3/3] Update copyright date. Sphinx default template name changed, name changed to keep consistent with existing doco --- source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/conf.py b/source/conf.py index 9775ed7..2fd8e56 100644 --- a/source/conf.py +++ b/source/conf.py @@ -41,7 +41,7 @@ # General information about the project. project = u'BrewPi' -copyright = u'2013, BrewPi' +copyright = u'2015, BrewPi' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -94,7 +94,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the