Update documentation

_sources/api/my_package.example.add_one.rst.txt

@@ -0,0 +1,6 @@
+add_one
+=======
+
+.. currentmodule:: my_package.example
+
+.. autofunction:: add_one

_sources/index.rst.txt

@@ -1,20 +1,67 @@
-.. No Errors Test Project documentation master file, created by
-   sphinx-quickstart on Fri Aug 30 17:07:56 2019.
+.. my_package documentation master file, created by
+   sphinx-quickstart on Tue Mar 22 13:13:41 2022.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to No Errors Test Project's documentation!
-==================================================
+Welcome to my_package's documentation!
+======================================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Hello World!
+   :caption: Contents:
 
 
+Here is where you can write the documentation for your package. 
+
+
+Usage
+=====
+
+.. _installation:
+
+Installation
+------------
+
+To use `my_package` you need to install X, Y and Z. 
+
+
+.. _code:
+
+Code
+----
+
+Here is an example of describing the use of your function.
+
+To add one to a number you can use the ``my_package.add_one()`` function:
+
+.. py:function:: my_package.add_one(number)
+
+
+    :param number: Should be integer, floating point number or a string. 
+
+    If ``number`` is not one of these types, an exception will be raised:
+
+    .. py:exception:: TypeError
+
+   Raised if the input is invalid.
+
+More about how to describe code can be hound 
+`here <https://www.sphinx-doc.org/en/master/tutorial/describing-code.html>`_
+
+
+..
+  The following section creates an index, a list of modules and a 
+  search page. 
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+..
+ The following will add the signature of the individual functions and pull
+ their docstrings.
+
+.. automodapi:: my_package.example

_static/alabaster.css

@@ -69,6 +69,11 @@ div.relations {
 }
 
 
+div.sphinxsidebar {
+    max-height: 100%;
+    overflow-y: auto;
+}
+
 div.sphinxsidebar a {
     color: #444;
     text-decoration: none;
@@ -155,6 +160,14 @@ div.sphinxsidebar input {
     font-size: 1em;
 }
 
+div.sphinxsidebar #searchbox input[type="text"] {
+    width: 160px;
+}
+
+div.sphinxsidebar .search > div {
+    display: table-cell;
+}
+
 div.sphinxsidebar hr {
     border: none;
     height: 1px;
@@ -419,7 +432,9 @@ table.footnote td {
 }
 
 dl {
-    margin: 0;
+    margin-left: 0;
+    margin-right: 0;
+    margin-top: 0;
     padding: 0;
 }
 
@@ -636,15 +651,7 @@ a:hover tt, a:hover code {
     display: none!important;
 }
 
-/* Make nested-list/multi-paragraph items look better in Releases changelog
- * pages. Without this, docutils' magical list fuckery causes inconsistent
- * formatting between different release sub-lists.
- */
-div#changelog > div.section > ul > li > p:only-child {
-    margin-bottom: 0;
-}
-
-/* Hide fugly table cell borders in ..bibliography:: directive output */
+/* Hide ugly table cell borders in ..bibliography:: directive output */
 table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
   border: none;
   /* Below needed in some edge cases; if not applied, bottom shadows appear */