adds docs and github actions

kyleniemeyer · Jan 5, 2024 · 621416f · 621416f
1 parent 1475366
commit 621416f
Show file tree

Hide file tree

Showing 15 changed files with 127 additions and 19 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/install.doctree b/docs/build/doctrees/install.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +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: 812561213026b0c1fc92cf770fe82532
+config: 1a0f3c9ef003526dfbf57abe0abf969c
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -1,10 +1,10 @@
-.. package documentation master file, created by
-   sphinx-quickstart on Thu Jan  4 10:18:12 2024.
+.. test-docs documentation master file, created by
+   sphinx-quickstart on Fri Jan  5 13:32:49 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to package's documentation!
-===================================
+Welcome to test-docs's documentation!
+=====================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/build/html/_sources/install.rst.txt b/docs/build/html/_sources/install.rst.txt
@@ -0,0 +1,4 @@
+Installation Instructions
+=========================
+
+This is where we see how to install.
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; package 0.0.1 documentation</title>
+    <title>Index &#8212; test-docs 0.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
     <script src="_static/documentation_options.js?v=d45e8c67"></script>
@@ -42,7 +42,7 @@ <h1 id="index">Index</h1>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="index.html">package</a></h1>
+<h1 class="logo"><a href="index.html">test-docs</a></h1>
 
 
 

diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Welcome to package’s documentation! &#8212; package 0.0.1 documentation</title>
+    <title>Welcome to test-docs’s documentation! &#8212; test-docs 0.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
     <script src="_static/documentation_options.js?v=d45e8c67"></script>
@@ -29,8 +29,8 @@
 
           <div class="body" role="main">
 
-  <section id="welcome-to-package-s-documentation">
-<h1>Welcome to package’s documentation!<a class="headerlink" href="#welcome-to-package-s-documentation" title="Link to this heading">¶</a></h1>
+  <section id="welcome-to-test-docs-s-documentation">
+<h1>Welcome to test-docs’s documentation!<a class="headerlink" href="#welcome-to-test-docs-s-documentation" title="Link to this heading">¶</a></h1>
 <div class="toctree-wrapper compound">
 </div>
 </section>
@@ -50,7 +50,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="#">package</a></h1>
+<h1 class="logo"><a href="#">test-docs</a></h1>
 
 
 

diff --git a/docs/build/html/install.html b/docs/build/html/install.html
@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>Installation Instructions &#8212; test-docs 0.0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
+    <script src="_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.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">
+
+  <section id="installation-instructions">
+<h1>Installation Instructions<a class="headerlink" href="#installation-instructions" title="Link to this heading">¶</a></h1>
+<p>This is where we see how to install.</p>
+</section>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">test-docs</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2024, Kyle Niemeyer.
+
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+      |
+      <a href="_sources/install.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
diff --git a/docs/build/html/search.html b/docs/build/html/search.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; package 0.0.1 documentation</title>
+    <title>Search &#8212; test-docs 0.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
 
@@ -71,7 +71,7 @@ <h1 id="search-documentation">Search</h1>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="index.html">package</a></h1>
+<h1 class="logo"><a href="index.html">test-docs</a></h1>
 
 
 

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,7 +6,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'package'
+project = 'test-docs'
 copyright = '2024, Kyle Niemeyer'
 author = 'Kyle Niemeyer'
 release = '0.0.1'

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,10 +1,10 @@
-.. package documentation master file, created by
-   sphinx-quickstart on Thu Jan  4 10:18:12 2024.
+.. test-docs documentation master file, created by
+   sphinx-quickstart on Fri Jan  5 13:32:49 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to package's documentation!
-===================================
+Welcome to test-docs's documentation!
+=====================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -0,0 +1,4 @@
+Installation Instructions
+=========================
+
+This is where we see how to install.