deepcharles · deepcharles · Mar 20, 2020 · Mar 20, 2020 · Mar 20, 2020 · Mar 20, 2020
diff --git a/.gitignore b/.gitignore
@@ -72,3 +72,12 @@ ruptures.sublime-workspace
 test.ipynb
 ruptures/detection/.circleci/run-build-locally.sh
 .circleci/run-build-locally.sh
+
+# OS generated files 
+.DS_Store
+./**/.DS_Store
+.DS_Store?
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
diff --git a/.gitmodules b/.gitmodules
@@ -1,6 +0,0 @@
-[submodule "docs/build"]
-	path = docs/build
-	url = [email protected]:tinquiete/ruptures-docs.git
-[submodule "docs"]
-	path = docs
-	url = [email protected]:tinquiete/ruptures-docs.git

diff --git a/docs b/docs
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python3 -msphinx
+SPHINXPROJ    = ruptures
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,17 @@
+Documentation for the `ruptures` package.
+
+
+In order to generate the documentation, the following packages are needed:
+```
+pip install sphinx
+pip install sphinx_rtd_theme
+pip install sphinxcontrib-bibtex
+```
+
+Make sure that the correct version of `ruptures` is installed. (The most probable situation is: you need the documentation for a local version of the `ruptures` library, therefore simply execute `python setup.py develop` in the top directory.)
+
+Then, you only need to 
+```
+make clean
+make html
+```
diff --git a/docs/build/doctrees/costs/costautoregressive.doctree b/docs/build/doctrees/costs/costautoregressive.doctree
diff --git a/docs/build/doctrees/costs/costcustom.doctree b/docs/build/doctrees/costs/costcustom.doctree
diff --git a/docs/build/doctrees/costs/costl1.doctree b/docs/build/doctrees/costs/costl1.doctree
diff --git a/docs/build/doctrees/costs/costl2.doctree b/docs/build/doctrees/costs/costl2.doctree
diff --git a/docs/build/doctrees/costs/costlinear.doctree b/docs/build/doctrees/costs/costlinear.doctree
diff --git a/docs/build/doctrees/costs/costml.doctree b/docs/build/doctrees/costs/costml.doctree
diff --git a/docs/build/doctrees/costs/costnormal.doctree b/docs/build/doctrees/costs/costnormal.doctree
diff --git a/docs/build/doctrees/costs/costrank.doctree b/docs/build/doctrees/costs/costrank.doctree
diff --git a/docs/build/doctrees/costs/costrbf.doctree b/docs/build/doctrees/costs/costrbf.doctree
diff --git a/docs/build/doctrees/costs/index.doctree b/docs/build/doctrees/costs/index.doctree
diff --git a/docs/build/doctrees/cpd.doctree b/docs/build/doctrees/cpd.doctree
diff --git a/docs/build/doctrees/datasets/index.doctree b/docs/build/doctrees/datasets/index.doctree
diff --git a/docs/build/doctrees/datasets/pw_constant.doctree b/docs/build/doctrees/datasets/pw_constant.doctree
diff --git a/docs/build/doctrees/datasets/pw_linear.doctree b/docs/build/doctrees/datasets/pw_linear.doctree
diff --git a/docs/build/doctrees/datasets/pw_normal.doctree b/docs/build/doctrees/datasets/pw_normal.doctree
diff --git a/docs/build/doctrees/datasets/pw_wavy.doctree b/docs/build/doctrees/datasets/pw_wavy.doctree
diff --git a/docs/build/doctrees/detection/binseg.doctree b/docs/build/doctrees/detection/binseg.doctree
diff --git a/docs/build/doctrees/detection/bottomup.doctree b/docs/build/doctrees/detection/bottomup.doctree
diff --git a/docs/build/doctrees/detection/dynp.doctree b/docs/build/doctrees/detection/dynp.doctree
diff --git a/docs/build/doctrees/detection/greedy/greedyar.doctree b/docs/build/doctrees/detection/greedy/greedyar.doctree
diff --git a/docs/build/doctrees/detection/greedy/index.doctree b/docs/build/doctrees/detection/greedy/index.doctree
diff --git a/docs/build/doctrees/detection/greedy/omp.doctree b/docs/build/doctrees/detection/greedy/omp.doctree
diff --git a/docs/build/doctrees/detection/greedy/ompk.doctree b/docs/build/doctrees/detection/greedy/ompk.doctree
diff --git a/docs/build/doctrees/detection/index.doctree b/docs/build/doctrees/detection/index.doctree
diff --git a/docs/build/doctrees/detection/pelt.doctree b/docs/build/doctrees/detection/pelt.doctree
diff --git a/docs/build/doctrees/detection/window.doctree b/docs/build/doctrees/detection/window.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/general-info.doctree b/docs/build/doctrees/general-info.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/license.doctree b/docs/build/doctrees/license.doctree
diff --git a/docs/build/doctrees/metrics/display.doctree b/docs/build/doctrees/metrics/display.doctree
diff --git a/docs/build/doctrees/metrics/hausdorff.doctree b/docs/build/doctrees/metrics/hausdorff.doctree
diff --git a/docs/build/doctrees/metrics/index.doctree b/docs/build/doctrees/metrics/index.doctree
diff --git a/docs/build/doctrees/metrics/precision.doctree b/docs/build/doctrees/metrics/precision.doctree
diff --git a/docs/build/doctrees/metrics/randindex.doctree b/docs/build/doctrees/metrics/randindex.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +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: 597ddb18f6462438ef270a89cebb5aad
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_images/correlation_shift.png b/docs/build/html/_images/correlation_shift.png
diff --git a/docs/build/html/_images/example-display.png b/docs/build/html/_images/example-display.png
diff --git a/docs/build/html/_images/hausdorff.png b/docs/build/html/_images/hausdorff.png
diff --git a/docs/build/html/_images/precision_recall.png b/docs/build/html/_images/precision_recall.png
diff --git a/docs/build/html/_images/randindex.png b/docs/build/html/_images/randindex.png
diff --git a/docs/build/html/_images/schema_binseg.png b/docs/build/html/_images/schema_binseg.png
diff --git a/docs/build/html/_images/schema_fenetre.png b/docs/build/html/_images/schema_fenetre.png
diff --git a/docs/build/html/_images/schema_tree.png b/docs/build/html/_images/schema_tree.png
diff --git a/docs/build/html/_images/sum_of_sines.png b/docs/build/html/_images/sum_of_sines.png
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -0,0 +1,219 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>Overview: module code &mdash; ruptures  documentation</title>
+
+
+
+
+
+
+
+
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+        <script src="../_static/language_data.js"></script>
+        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
+
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="../index.html" class="icon icon-home"> ruptures
+
+
+
+          </a>
+
+
+
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../general-info.html">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general-info.html#installation">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general-info.html#user-guide">User guide</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../cpd.html">Change point detection: a general formulation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../detection/index.html">Search methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../costs/index.html">Cost functions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../datasets/index.html">Synthetic signals</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../metrics/index.html">Evaluation</a></li>
+</ul>
+
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">ruptures</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="../index.html">Docs</a> &raquo;</li>
+
+      <li>Overview: module code</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="ruptures/costs/costautoregressive.html">ruptures.costs.costautoregressive</a></li>
+<li><a href="ruptures/costs/costl1.html">ruptures.costs.costl1</a></li>
+<li><a href="ruptures/costs/costl2.html">ruptures.costs.costl2</a></li>
+<li><a href="ruptures/costs/costlinear.html">ruptures.costs.costlinear</a></li>
+<li><a href="ruptures/costs/costml.html">ruptures.costs.costml</a></li>
+<li><a href="ruptures/costs/costnormal.html">ruptures.costs.costnormal</a></li>
+<li><a href="ruptures/costs/costrank.html">ruptures.costs.costrank</a></li>
+<li><a href="ruptures/costs/costrbf.html">ruptures.costs.costrbf</a></li>
+<li><a href="ruptures/datasets/pw_constant.html">ruptures.datasets.pw_constant</a></li>
+<li><a href="ruptures/datasets/pw_linear.html">ruptures.datasets.pw_linear</a></li>
+<li><a href="ruptures/datasets/pw_normal.html">ruptures.datasets.pw_normal</a></li>
+<li><a href="ruptures/datasets/pw_wavy.html">ruptures.datasets.pw_wavy</a></li>
+<li><a href="ruptures/detection/binseg.html">ruptures.detection.binseg</a></li>
+<li><a href="ruptures/detection/bottomup.html">ruptures.detection.bottomup</a></li>
+<li><a href="ruptures/detection/dynp.html">ruptures.detection.dynp</a></li>
+<li><a href="ruptures/detection/pelt.html">ruptures.detection.pelt</a></li>
+<li><a href="ruptures/detection/window.html">ruptures.detection.window</a></li>
+<li><a href="ruptures/metrics/hausdorff.html">ruptures.metrics.hausdorff</a></li>
+<li><a href="ruptures/metrics/precisionrecall.html">ruptures.metrics.precisionrecall</a></li>
+<li><a href="ruptures/metrics/randindex.html">ruptures.metrics.randindex</a></li>
+<li><a href="ruptures/show/display.html">ruptures.show.display</a></li>
+</ul>
+
+           </div>
+
+          </div>
+          <footer>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2017, ENS Paris-Saclay, CNRS
+      <span class="lastupdated">
+        Last updated on Mar 20, 2020.
+      </span>
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>