Merge pull request #1 from transientlunatic/new-api

Add the new API which breaks backwards compatibility

.gitattributes

@@ -0,0 +1 @@
+otter/_version.py export-subst

HISTORY.rst

@@ -7,3 +7,12 @@ History
 ---------------------
 
 * First release on PyPI.
+
+0.2.0 (2018-07-18)
+------------------
+
+"Beinn Dorain"
+
+* New API for adding material to reports
+* Full support for matplotlib plots
+* Support for multiple data types in reports

MANIFEST.in

@@ -9,3 +9,5 @@ recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 
 recursive-include docs *.rst conf.py Makefile make.bat
+include versioneer.py
+include otter/_version.py

README.rst

@@ -15,7 +15,10 @@ Otter
 
 Otter is a simple HTML report generator for Python jobs. Otter was
 designed to produce reports on long-running jobs on remote machines,
-and send them to a web server.
+and send them to a web server, but it's able to process many different
+outputs from Python scripts, and convert them into neat and readible HTML pages.
+
+Otter makes use of Twitter Bootstrap to make an easily themed layout for its output.
 
 * Free software: ISC license
 * Documentation: https://otter.readthedocs.org.

docs/_static/bootstrap-sphinx.css

@@ -0,0 +1,242 @@
+/*
+ * bootstrap-sphinx.css
+ * ~~~~~~~~~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- Bootstrap theme.
+ */
+
+.navbar-inverse .brand {
+  color: #FFF;
+}
+
+/*
+ * Reset navbar styles from overrides in:
+ * https://bitbucket.org/birkenfeld/sphinx/commits/78d8ebf76b630ab4073a7328af9d91e8123b8d96
+ */
+.navbar .container {
+  padding-top: 0;
+}
+
+.page-top {
+  top: 0px;
+}
+
+{% if theme_navbar_fixed_top|tobool %}
+
+{% if theme_bootstrap_version == "2" %}
+@media (min-width: 980px) {
+{% endif %}
+
+{% if theme_bootstrap_version == "2" %}
+}
+{% endif %}
+
+.navbar-inner {
+  padding-left:  12px !important;
+  padding-right: 12px !important;
+}
+{% else %}
+{% if theme_bootstrap_version == "2" %}
+@media (min-width: 980px) {
+  .navbar .container {
+    width: 940px;
+  }
+}
+{% endif %}
+{% endif %}
+
+table {
+  border: 0;
+}
+
+.highlighttable .code pre {
+    font-size: 12px;
+}
+
+.highlighttable .linenos pre {
+    word-break: normal;
+    font-size: 12px;
+}
+
+div.highlight {
+  background: none;
+}
+
+a.footnote-reference {
+  vertical-align: super;
+  font-size: 75%;
+}
+
+table.footnote td.label {
+  font-size: 100%;
+  display: block;
+  line-height: normal;
+  background: inherit;
+}
+
+table.footnote {
+  width: auto;
+  margin-bottom: 0px;
+}
+
+table.field-list {
+  width: auto;
+}
+
+.footer {
+  width: 100%;
+  border-top: 1px solid #ccc;
+  padding-top: 10px;
+}
+
+.bs-sidenav form, .bs-sidenav #sourcelink {
+  padding: 5px 20px;
+}
+
+{% if theme_bootstrap_version == "3" %}
+
+/* The code below is based on the bootstrap website sidebar */
+
+.bs-sidenav.affix {
+  position: static;
+}
+
+/* First level of nav */
+.bs-sidenav {
+  margin-top: 30px;
+  margin-bottom: 30px;
+  padding-top:    10px;
+  padding-bottom: 10px;
+  text-shadow: 0 1px 0 #fff;
+  background-color: #f7f5fa;
+  border-radius: 5px;
+}
+
+/* All levels of nav */
+.bs-sidenav .nav > li > a {
+  display: block;
+  color: #716b7a;
+  padding: 5px 20px;
+}
+.bs-sidenav .nav > li > a:hover,
+.bs-sidenav .nav > li > a:focus {
+  text-decoration: none;
+  background-color: #e5e3e9;
+  border-right: 1px solid #dbd8e0;
+}
+.bs-sidenav .nav > .active > a,
+.bs-sidenav .nav > .active:hover > a,
+.bs-sidenav .nav > .active:focus > a {
+  font-weight: bold;
+  color: #563d7c;
+  background-color: transparent;
+  border-right: 1px solid #563d7c;
+}
+
+.bs-sidenav .nav .nav > li > a {
+  padding-top:    3px;
+  padding-bottom: 3px;
+  padding-left: 30px;
+  font-size: 90%;
+}
+
+.bs-sidenav .nav .nav .nav > li > a {
+  padding-top:    3px;
+  padding-bottom: 3px;
+  padding-left: 40px;
+  font-size: 90%;
+}
+
+.bs-sidenav .nav .nav .nav .nav > li > a {
+  padding-top:    3px;
+  padding-bottom: 3px;
+  padding-left: 50px;
+  font-size: 90%;
+}
+
+/* Show and affix the side nav when space allows it */
+@media screen and (min-width: 992px) {
+  .bs-sidenav .nav > .active > ul {
+    display: block;
+  }
+  /* Widen the fixed sidenav */
+  .bs-sidenav.affix,
+  .bs-sidenav.affix-bottom {
+    width: 213px;
+  }
+  .bs-sidenav.affix {
+    position: fixed; /* Undo the static from mobile first approach */
+  }
+  .bs-sidenav.affix-bottom {
+    position: absolute; /* Undo the static from mobile first approach */
+  }
+  .bs-sidenav.affix-bottom .bs-sidenav,
+  .bs-sidenav.affix .bs-sidenav {
+    margin-top: 0;
+    margin-bottom: 0;
+  }
+}
+@media screen and (min-width: 1200px) {
+  /* Widen the fixed sidenav again */
+  .bs-sidenav.affix-bottom,
+  .bs-sidenav.affix {
+    width: 263px;
+  }
+}
+
+
+{% else %}
+
+.bs-sidenav {
+  width: 228px;
+  margin: 30px 0 0;
+  padding: 10px 0 0 5px;
+}
+
+.bs-sidenav ul{
+  list-style-type: none;
+  padding-left: 25px;
+  margin-left: 0;  /* bootstrap 2 compatability. */
+}
+
+@media (min-width: 1200px) {
+  .bs-sidenav {
+      width: 258px;
+  }
+}
+
+/* Desktop
+------------------------- */
+@media (max-width: 980px) {
+  .bs-sidenav {
+    width: 218px;
+    margin-top: 30px;
+    margin-right: 0;
+  }
+}
+
+/* Tablet to desktop
+------------------------- */
+@media (min-width: 768px) and (max-width: 979px) {
+  .bs-sidenav {
+    width: 166px;
+    margin-top: 20px;
+  }
+}
+
+/* Tablet
+------------------------- */
+@media (max-width: 767px) {
+  .navbar-version {
+    padding-left: 5px;
+  }
+  .bs-sidenav {
+    width: auto;
+    margin-bottom: 20px;
+  }
+  .bs-sidenav.affix {
+    position: static;
+    top: 0;
+  }
+}
+{% endif %}

docs/_templates/globaltoc.html

@@ -0,0 +1,11 @@
+<li class="nav-item dropdown globaltoc-container">
+  <a role="button"
+     class="nav-link dropdown-toggle"
+     id="dLabelGlobalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="{{ pathto(master_doc) }}">{{ theme_navbar_site_name }}</a>
+  <ul class="dropdown-menu globaltoc"
+      role="menu"
+      aria-labelledby="dLabelGlobalToc">{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}</ul>
+</li>