added how to commit

VirtualDataLab · Dec 24, 2018 · f7673d1 · f7673d1
1 parent 79d3924
commit f7673d1
Show file tree

Hide file tree

Showing 13 changed files with 149 additions and 7 deletions.
diff --git a/docs/How to contribute.rst b/docs/How to contribute.rst
@@ -0,0 +1,13 @@
+How to contribute
+=================
+
+If you want to contribute to the documentation, go to the smobsc directory and
+then acess the "docs" folder. There you will find an index.rst file. This
+is basically where you see the main structure of the documentation with all the
+headers, subheaders etc. If you want to link to a new section, you have to add
+it under toctree. When building the documentation sphinx will go through the
+sections under toctree and look for .rst files with the same names in the docs
+directory. Once you've added the section in the index.rst file and added the
+corresponding .rst file in the docs directory, you can build the html with
+"make html".
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,8 +4,8 @@ Let's see if this worked...
 Some text explaining very important complicated stuff.
 Some code:
 
-    print 'hello'
-    >> hello
+   print 'hello'
+   >> hello
 
 Second try to see if it worked 
 
@@ -16,7 +16,7 @@ Some header
 
    license
    help
-
+   How to contribute
 
 
 Indices and tables

diff --git a/docs/nbuild/doctrees/How to contribute.doctree b/docs/nbuild/doctrees/How to contribute.doctree
diff --git a/docs/nbuild/doctrees/environment.pickle b/docs/nbuild/doctrees/environment.pickle
diff --git a/docs/nbuild/doctrees/index.doctree b/docs/nbuild/doctrees/index.doctree
diff --git a/docs/nbuild/html/How to contribute.html b/docs/nbuild/html/How to contribute.html
@@ -0,0 +1,112 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>How to contribute &#8212; smobsc 0.0.1 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>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="help" href="help.html" />
+
+  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <div class="section" id="how-to-contribute">
+<h1>How to contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline">¶</a></h1>
+<p>If you want to contribute to the documentation, go to the smobsc directory and
+then acess the “docs” folder. There you will find an index.rst file. This
+is basically where you see the main structure of the documentation with all the
+headers, subheaders etc. If you want to link to a new section, you have to add
+it under toctree. When building the documentation sphinx will go through the
+sections under toctree and look for .rst files with the same names in the docs
+directory. Once you’ve added the section in the index.rst file and added the
+corresponding .rst file in the docs directory, you can build the html with
+“make html”.</p>
+</div>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">smobsc</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="license.html#contact">Contact</a></li>
+<li class="toctree-l1"><a class="reference internal" href="help.html">help</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">How to contribute</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="help.html" title="previous chapter">help</a></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <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>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2018, everyone.
+
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.9</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
+
+      |
+      <a href="_sources/How to contribute.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/nbuild/html/_sources/How to contribute.rst.txt b/docs/nbuild/html/_sources/How to contribute.rst.txt
@@ -0,0 +1,13 @@
+How to contribute
+=================
+
+If you want to contribute to the documentation, go to the smobsc directory and
+then acess the "docs" folder. There you will find an index.rst file. This
+is basically where you see the main structure of the documentation with all the
+headers, subheaders etc. If you want to link to a new section, you have to add
+it under toctree. When building the documentation sphinx will go through the
+sections under toctree and look for .rst files with the same names in the docs
+directory. Once you've added the section in the index.rst file and added the
+corresponding .rst file in the docs directory, you can build the html with
+"make html".
+
diff --git a/docs/nbuild/html/_sources/index.rst.txt b/docs/nbuild/html/_sources/index.rst.txt
@@ -4,8 +4,8 @@ Let's see if this worked...
 Some text explaining very important complicated stuff.
 Some code:
 
-    print 'hello'
-    >> hello
+   print 'hello'
+   >> hello
 
 Second try to see if it worked 
 
@@ -16,7 +16,7 @@ Some header
 
    license
    help
-
+   How to contribute
 
 
 Indices and tables

diff --git a/docs/nbuild/html/genindex.html b/docs/nbuild/html/genindex.html
@@ -60,6 +60,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html#contact">Contact</a></li>
 <li class="toctree-l1"><a class="reference internal" href="help.html">help</a></li>
+<li class="toctree-l1"><a class="reference internal" href="How to contribute.html">How to contribute</a></li>
 </ul>
 
 <div class="relations">

diff --git a/docs/nbuild/html/index.html b/docs/nbuild/html/index.html
@@ -48,6 +48,7 @@ <h2>Some header<a class="headerlink" href="#some-header" title="Permalink to thi
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html#contact">Contact</a></li>
 <li class="toctree-l1"><a class="reference internal" href="help.html">help</a></li>
+<li class="toctree-l1"><a class="reference internal" href="How to contribute.html">How to contribute</a></li>
 </ul>
 </div>
 </div>
@@ -82,6 +83,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html#contact">Contact</a></li>
 <li class="toctree-l1"><a class="reference internal" href="help.html">help</a></li>
+<li class="toctree-l1"><a class="reference internal" href="How to contribute.html">How to contribute</a></li>
 </ul>
 
 <div class="relations">

diff --git a/docs/nbuild/html/objects.inv b/docs/nbuild/html/objects.inv
diff --git a/docs/nbuild/html/search.html b/docs/nbuild/html/search.html
@@ -83,6 +83,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html#contact">Contact</a></li>
 <li class="toctree-l1"><a class="reference internal" href="help.html">help</a></li>
+<li class="toctree-l1"><a class="reference internal" href="How to contribute.html">How to contribute</a></li>
 </ul>
 
 <div class="relations">

diff --git a/docs/nbuild/html/searchindex.js b/docs/nbuild/html/searchindex.js