minor typo in r_squared docstring

cjekel · Feb 25, 2019 · ace41f4 · ace41f4
1 parent d594c44
commit ace41f4
Show file tree

Hide file tree

Showing 28 changed files with 33 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.5] - 2019-02-25
+### Changed
+- minor correction to r_squared docstring example
+
 ## [0.3.4] - 2019-02-06
 ### Added
 - Uploaded paper and citation information

diff --git a/convert_README_to_RST.sh b/convert_README_to_RST.sh
@@ -1 +1,2 @@
+#!/usr/bin/env bash
 pandoc --from=markdown --to=rst --output=README.rst README.md
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.3.4',
+    VERSION: '0.3.5',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

diff --git a/docs/about.html b/docs/about.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>About &#8212; pwlf 0.3.4 documentation</title>
+    <title>About &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/examples.html b/docs/examples.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Examples &#8212; pwlf 0.3.4 documentation</title>
+    <title>Examples &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Index &#8212; pwlf 0.3.4 documentation</title>
+    <title>Index &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/how_it_works.html b/docs/how_it_works.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>How it works &#8212; pwlf 0.3.4 documentation</title>
+    <title>How it works &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/index.html b/docs/index.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pwlf: piecewise linear fitting &#8212; pwlf 0.3.4 documentation</title>
+    <title>pwlf: piecewise linear fitting &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/installation.html b/docs/installation.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Installation &#8212; pwlf 0.3.4 documentation</title>
+    <title>Installation &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/license.html b/docs/license.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>License &#8212; pwlf 0.3.4 documentation</title>
+    <title>License &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/modules.html b/docs/modules.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pwlf &#8212; pwlf 0.3.4 documentation</title>
+    <title>pwlf &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/pwlf.html b/docs/pwlf.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pwlf package contents &#8212; pwlf 0.3.4 documentation</title>
+    <title>pwlf package contents &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -952,7 +952,7 @@ <h1>pwlf package contents<a class="headerlink" href="#pwlf-package-contents" tit
 <span class="gp">&gt;&gt;&gt; </span><span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">my_pwlf</span> <span class="o">=</span> <span class="n">pwlf</span><span class="o">.</span><span class="n">PiecewiseLinFit</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">breaks</span> <span class="o">=</span> <span class="n">my_pwlf</span><span class="o">.</span><span class="n">fitfast</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">rsq</span> <span class="o">=</span> <span class="n">PiecewiseLinFit</span><span class="o">.</span><span class="n">r_squared</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">rsq</span> <span class="o">=</span> <span class="n">my_pwlf</span><span class="o">.</span><span class="n">r_squared</span><span class="p">()</span>
 </pre></div>
 </div>
 </dd></dl>

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Python Module Index &#8212; pwlf 0.3.4 documentation</title>
+    <title>Python Module Index &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/requirements.html b/docs/requirements.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Requirements &#8212; pwlf 0.3.4 documentation</title>
+    <title>Requirements &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/search.html b/docs/search.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Search &#8212; pwlf 0.3.4 documentation</title>
+    <title>Search &#8212; pwlf 0.3.5 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 

diff --git a/doctrees/about.doctree b/doctrees/about.doctree
diff --git a/doctrees/environment.pickle b/doctrees/environment.pickle
diff --git a/doctrees/examples.doctree b/doctrees/examples.doctree
diff --git a/doctrees/how_it_works.doctree b/doctrees/how_it_works.doctree
diff --git a/doctrees/index.doctree b/doctrees/index.doctree
diff --git a/doctrees/installation.doctree b/doctrees/installation.doctree
diff --git a/doctrees/license.doctree b/doctrees/license.doctree
diff --git a/doctrees/modules.doctree b/doctrees/modules.doctree
diff --git a/doctrees/pwlf.doctree b/doctrees/pwlf.doctree
diff --git a/doctrees/requirements.doctree b/doctrees/requirements.doctree
diff --git a/pwlf/VERSION b/pwlf/VERSION
@@ -1 +1 @@
-0.3.4
+0.3.5
diff --git a/pwlf/pwlf.py b/pwlf/pwlf.py
@@ -1509,7 +1509,7 @@ def r_squared(self):
         >>> y = np.random.random(10)
         >>> my_pwlf = pwlf.PiecewiseLinFit(x, y)
         >>> breaks = my_pwlf.fitfast(3)
-        >>> rsq = PiecewiseLinFit.r_squared()
+        >>> rsq = my_pwlf.r_squared()
 
         """
         try:

diff --git a/sphinx_build_script.sh b/sphinx_build_script.sh
@@ -0,0 +1,12 @@
+
+#!/usr/bin/env bash
+# clean docs and doctrees
+rm -r docs/*
+rm -r doctrees/*
+# make the documentation in gitignore folder
+cd sphinxdocs
+make clean
+make html
+# copy sphinx build into docs and doctrees
+cp -r build/doctrees/* ../doctrees/
+cp -r build/html/* ../docs/