Update README

README.md

@@ -1,14 +1,13 @@
-# ![BrewPi Legacy Remix Logo](https://raw.githubusercontent.com/lbussy/brewpi-www-rmx/master/images/brewpi_logo.png)
-BrewPi Remix Documentation
-==========================
+# <a name="top"></a>![BrewPi Legacy Remix Logo](https://raw.githubusercontent.com/brewpi-remix/brewpi-www-rmx/master/images/brewpi_logo.png)
 
-This repository contains documentation created for users of [BrewPi Remix](https://www.brewpiremix.com).
+This is [@LBussy](https://github.com/lbussy)'s forks of the original [BrewPi Project](https://github.com/BrewPi).  This project has a new website, please also visit https://www.brewpiremix.com.
 
-License
--------
-BrewPi-UserDocs-RMX is licensed under the [GNU General Public License v3.0](https://github.com/lbussy/brewpi-userdocs-rmx/blob/master/LICENSE).
+This repository contains the documentation for [BrewPi Remix](https://www.brewpiremix.com) which runs on a [Raspberry Pi](https://www.raspberrypi.org/), communicating with an [Arduino](https://www.arduino.cc/en/guide/introduction).  
 
-Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.
+These [forks](https://en.wikipedia.org/wiki/Fork_(software_development)) are intended for the fans of the *original* BrewPi (called "Legacy" in BrewPi circles).  For current [BrewPi Spark 3](https://www.brewpi.com/) information and support, please continue to use and support [the original project](https://github.com/BrewPi).
 
-[![Documentation 
-Status](https://readthedocs.org/projects/brewpi-userdocs-rmx/badge/?version=legacy)](https://brewpi-userdocs-rmx.readthedocs.io/en/devel/?badge=devel)
+# Getting Started
+
+To get started, please head over to the [BrewPi Remix Tools](https://github.com/brewpi-remix/brewpi-tools-rmx/blob/master/README.md) README page, and follow along there.
+
+If you are looking only to view the documentation, it is available [at this link](https://docs.brewpiremix.com).

_build/html/.buildinfo

@@ -1,4 +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: 8e2d911b45149a3774e3ddab53207ee8
+config: 834109fb9847b0d3c93489ab5e17b867
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_build/html/_static/basic.css

@@ -231,16 +231,6 @@ a.headerlink {
     visibility: hidden;
 }
 
-a.brackets:before,
-span.brackets > a:before{
-    content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
-    content: "]";
-}
-
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -289,12 +279,6 @@ img.align-center, .figure.align-center, object.align-center {
   margin-right: auto;
 }
 
-img.align-default, .figure.align-default {
-  display: block;
-  margin-left: auto;
-  margin-right: auto;
-}
-
 .align-left {
     text-align: left;
 }
@@ -303,10 +287,6 @@ img.align-default, .figure.align-default {
     text-align: center;
 }
 
-.align-default {
-    text-align: center;
-}
-
 .align-right {
     text-align: right;
 }
@@ -378,11 +358,6 @@ table.align-center {
     margin-right: auto;
 }
 
-table.align-default {
-    margin-left: auto;
-    margin-right: auto;
-}
-
 table caption span.caption-number {
     font-style: italic;
 }
@@ -416,16 +391,6 @@ table.citation td {
     border-bottom: none;
 }
 
-th > p:first-child,
-td > p:first-child {
-    margin-top: 0px;
-}
-
-th > p:last-child,
-td > p:last-child {
-    margin-bottom: 0px;
-}
-
 /* -- figures --------------------------------------------------------------- */
 
 div.figure {
@@ -495,57 +460,11 @@ ol.upperroman {
     list-style: upper-roman;
 }
 
-li > p:first-child {
-    margin-top: 0px;
-}
-
-li > p:last-child {
-    margin-bottom: 0px;
-}
-
-dl.footnote > dt,
-dl.citation > dt {
-    float: left;
-}
-
-dl.footnote > dd,
-dl.citation > dd {
-    margin-bottom: 0em;
-}
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
-    content: "";
-    clear: both;
-}
-
-dl.field-list {
-    display: flex;
-    flex-wrap: wrap;
-}
-
-dl.field-list > dt {
-    flex-basis: 20%;
-    font-weight: bold;
-    word-break: break-word;
-}
-
-dl.field-list > dt:after {
-    content: ":";
-}
-
-dl.field-list > dd {
-    flex-basis: 70%;
-    padding-left: 1em;
-    margin-left: 0em;
-    margin-bottom: 0em;
-}
-
 dl {
     margin-bottom: 15px;
 }
 
-dd > p:first-child {
+dd p {
     margin-top: 0px;
 }
 
@@ -618,12 +537,6 @@ dl.glossary dt {
     font-style: oblique;
 }
 
-.classifier:before {
-    font-style: normal;
-    margin: 0.5em;
-    content: ":";
-}
-
 abbr, acronym {
     border-bottom: dotted 1px;
     cursor: help;

_build/html/_static/bizstyle.css

@@ -400,20 +400,6 @@ p.versionchanged span.versionmodified {
     background-color: #DCE6A0;
 }
 
-dl.field-list > dt {
-    color: white;
-    padding-left: 0.5em;
-    padding-right: 5px;
-    background-color: #82A0BE;
-}
-
-dl.field-list > dd {
-    padding-left: 0.5em;
-    margin-top: 0em;
-    margin-left: 0em;
-    background-color: #f7f7f7;
-}
-
 /* -- table styles ---------------------------------------------------------- */
 
 table.docutils {

_build/html/_static/doctools.js

@@ -87,13 +87,14 @@ jQuery.fn.highlightText = function(text, className) {
           node.nextSibling));
         node.nodeValue = val.substr(0, pos);
         if (isInSVG) {
+          var bbox = span.getBBox();
           var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
-          var bbox = node.parentElement.getBBox();
-          rect.x.baseVal.value = bbox.x;
+       	  rect.x.baseVal.value = bbox.x;
           rect.y.baseVal.value = bbox.y;
           rect.width.baseVal.value = bbox.width;
           rect.height.baseVal.value = bbox.height;
           rect.setAttribute('class', className);
+          var parentOfText = node.parentNode.parentNode;
           addItems.push({
               "parent": node.parentNode,
               "target": rect});

_build/html/_static/documentation_options.js

@@ -6,5 +6,5 @@ var DOCUMENTATION_OPTIONS = {
     FILE_SUFFIX: '.html',
     HAS_SOURCE: true,
     SOURCELINK_SUFFIX: '.txt',
-    NAVIGATION_WITH_KEYS: false
+    NAVIGATION_WITH_KEYS: false,
 };

_build/html/_static/searchtools.js

@@ -36,10 +36,8 @@ if (!Scorer) {
 
     // query found in title
     title: 15,
-    partialTitle: 7,
     // query found in terms
-    term: 5,
-    partialTerm: 2
+    term: 5
   };
 }
 
@@ -58,14 +56,6 @@ var Search = {
   _queued_query : null,
   _pulse_status : -1,
 
-  htmlToText : function(htmlString) {
-      var htmlElement = document.createElement('span');
-      htmlElement.innerHTML = htmlString;
-      $(htmlElement).find('.headerlink').remove();
-      docContent = $(htmlElement).find('[role=main]')[0];
-      return docContent.textContent || docContent.innerText;
-  },
-
   init : function() {
       var params = $.getQueryParameters();
       if (params.q) {
@@ -130,7 +120,7 @@ var Search = {
     this.out = $('#search-results');
     this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
     this.dots = $('<span></span>').appendTo(this.title);
-    this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
+    this.status = $('<p style="display: none"></p>').appendTo(this.out);
     this.output = $('<ul class="search"/>').appendTo(this.out);
 
     $('#search-progress').text(_('Preparing search...'));
@@ -269,7 +259,11 @@ var Search = {
             displayNextItem();
           });
         } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
-          $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
+          var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
+          if (suffix === undefined) {
+            suffix = '.txt';
+          }
+          $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
                   dataType: "text",
                   complete: function(jqxhr, textstatus) {
                     var data = jqxhr.responseText;
@@ -319,13 +313,12 @@ var Search = {
     for (var prefix in objects) {
       for (var name in objects[prefix]) {
         var fullname = (prefix ? prefix + '.' : '') + name;
-        var fullnameLower = fullname.toLowerCase()
-        if (fullnameLower.indexOf(object) > -1) {
+        if (fullname.toLowerCase().indexOf(object) > -1) {
           var score = 0;
-          var parts = fullnameLower.split('.');
+          var parts = fullname.split('.');
           // check for different match types: exact matches of full name or
           // "last name" (i.e. last dotted part)
-          if (fullnameLower == object || parts[parts.length - 1] == object) {
+          if (fullname == object || parts[parts.length - 1] == object) {
             score += Scorer.objNameMatch;
           // matches in last name
           } else if (parts[parts.length - 1].indexOf(object) > -1) {
@@ -392,19 +385,6 @@ var Search = {
         {files: terms[word], score: Scorer.term},
         {files: titleterms[word], score: Scorer.title}
       ];
-      // add support for partial matches
-      if (word.length > 2) {
-        for (var w in terms) {
-          if (w.match(word) && !terms[word]) {
-            _o.push({files: terms[w], score: Scorer.partialTerm})
-          }
-        }
-        for (var w in titleterms) {
-          if (w.match(word) && !titleterms[word]) {
-              _o.push({files: titleterms[w], score: Scorer.partialTitle})
-          }
-        }
-      }
 
       // no match but word was a required one
       if ($u.every(_o, function(o){return o.files === undefined;})) {
@@ -444,12 +424,8 @@ var Search = {
       var valid = true;
 
       // check if all requirements are matched
-      var filteredTermCount = // as search terms with length < 3 are discarded: ignore
-        searchterms.filter(function(term){return term.length > 2}).length
-      if (
-        fileMap[file].length != searchterms.length &&
-        fileMap[file].length != filteredTermCount
-      ) continue;
+      if (fileMap[file].length != searchterms.length)
+          continue;
 
       // ensure that none of the excluded terms is in the search result
       for (i = 0; i < excluded.length; i++) {
@@ -480,8 +456,7 @@ var Search = {
    * words. the first one is used to find the occurrence, the
    * latter for highlighting it.
    */
-  makeSearchSummary : function(htmlText, keywords, hlwords) {
-    var text = Search.htmlToText(htmlText);
+  makeSearchSummary : function(text, keywords, hlwords) {
     var textLower = text.toLowerCase();
     var start = 0;
     $.each(keywords, function() {

_build/html/automated/index.html

@@ -4,7 +4,8 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Automated Installation of BrewPi &#8212; BrewPi Remix 0.5.3 documentation</title>
     <link rel="stylesheet" href="../_static/bizstyle.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -64,11 +65,13 @@ <h3>This Page</h3>
     </ul>
    </div>
 <div id="searchbox" style="display: none" role="search">
-  <h3 id="searchlabel">Quick search</h3>
+  <h3>Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <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>
     </div>
 </div>
@@ -125,7 +128,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Lee C. Bussy.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.0.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
     </div>
   </body>
 </html>