Issue #17: Adding docs folder

.gitignore

@@ -30,6 +30,7 @@ wheels/
 .installed.cfg
 *.egg
 
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
@@ -68,6 +69,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/source/API Reference
+docs/source/Examples
 
 # Pickles
 *.pkl
@@ -81,7 +84,6 @@ target/
 # PDFs and Images
 *.pdf 
 *.jpg
-*.png
 
 # pyenv
 .python-version

CITATION.cff

@@ -0,0 +1,19 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Stephenson"
+  given-names: "Mark"
+  # orcid: "https://orcid.org/0000-0000-0000-0000"
+- family-names: "Mantovani"
+  given-names: "Lorenzzo"
+  # orcid: "https://orcid.org/0000-0000-0000-0000"
+- family-names: "Herrmann"
+  given-names: "Adam"
+  # orcid: "https://orcid.org/0000-0000-0000-0000"
+- family-names: "Schaub"
+  given-names: "Hanspeter"
+  # orcid: "https://orcid.org/0000-0000-0000-0000"
+title: "BSK-RL"
+version: 0.0.0
+date-released: 2023
+url: "https://github.com/AVSLab/bsk_rl/"

docs/Makefile

@@ -0,0 +1,28 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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)
+
+clean:
+	rm -rf "source/Examples" "source/API Reference"
+
+
+view:
+	# works on macOS
+	open build/html/index.html

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/custom.css

@@ -0,0 +1,209 @@
+div.textblock a, div.textblock a:visited, p a, p a:visited,
+a, a:hover, a:visited,
+a.reference, a.internal, a.current {
+	color: #cfb87c;
+	font-weight: bold;
+}
+
+a.icon-home, a.icon-home:visited {
+	color: #666;
+}
+
+div.wy-menu > p.caption > span.caption-text {
+	color: white;
+	font-weight: bold;
+}
+a.el, a.el:visited {
+	color: #565A5C;
+}
+
+.wy-side-nav-search>div.version {
+	color: #565A5C; # CU dark gray
+}
+
+.wy-nav-content {
+    max-width: none;
+}
+
+code span.pre, code {
+	color: #cb7ccf;
+}
+
+th.head, .wy-nav-top  {
+	color: white;
+	background-color: #565A5C;
+}
+
+th.head p {
+	margin: 0px;
+}
+
+tr td p, th.head p {
+	font-size: small;
+}
+
+img.logo {
+	filter: drop-shadow(0px 0px 8px #fff);
+}
+/* override table no-wrap */
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: normal;
+}
+
+.math {
+    text-align: left;
+}
+.eqno {
+    float: right;
+}
+
+body, h1, h2, h3, h4, h5, .rst-content, .sidebar, .sidebar-title, p.caption {
+  font-family: system-ui, -apple-system, BlinkMacSystemFont, "Helvetica Neue",
+      "Lucida Grande", "Segoe UI" !important;
+}
+
+:root {
+	color-scheme: light dark;
+}
+
+.sidebar {
+	max-width: 500px;
+}
+
+code, .rst-content tt, .rst-content code {
+	color: #E74C3C;
+}
+
+ul.simple li, aside.sidebar ul li {
+	all: revert;
+}
+
+ul.simple li p, aside.sidebar ul li p {
+	all: revert;
+	line-height: 24px;
+	font-size: 16px;
+	margin: 0px;
+}
+
+ul.simple ul li {
+	list-style-type: circle;
+	margin-left: 1.5em;
+}
+
+ul.simple, aside.sidebar ul {
+	all: revert;
+	padding-left: 1.5em;
+}
+
+figure {
+	text-align: center;
+}
+
+@media (prefers-color-scheme: dark) {
+	.wy-nav-content, .wy-body-for-nav, .wy-nav-content-wrap, math, span[id*='MathJax-Span'] {
+		background-color: black;
+		color:  #ccc;
+	}
+
+	.highlight .go {
+		color:  #ccc;
+	}
+
+	img.logo {
+		filter: drop-shadow(0px 0px 8px #000);
+	}
+
+	.rst-content code {
+		background: #0004;
+	}
+	html.writer-html4 .rst-content dl:not(.docutils)>dt, html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt, .rst-content .note {
+		background: #2D4151;
+	}
+
+	.rst-content .warning, .rst-content .caution, .rst-content .attention {
+		background: #51402F;
+	}
+
+	.rst-content .important, .rst-content .hint, .rst-content .tip {
+		background: #275145;
+	}
+
+	.rst-content .danger, .rst-content .error {
+		background: #523A37;
+	}
+
+	/* sidebar formatting */
+	.sidebar {
+		border-color: #666;
+	}
+	.rst-content .sidebar {
+		background: #222;
+	}
+	.rst-content .sidebar .sidebar-title {
+		background: #666;
+	}
+
+
+	.btn-neutral, .btn-neutral:hover, .btn:visited {
+		background: #333 !important;
+		color: #ccc !important;
+	}
+
+	.highlight {
+		background: #4448;
+	}
+
+	.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td {
+		background-color: #222;
+	}
+
+	.rst-content pre.literal-block, .rst-content div[class^='highlight'], .rst-content code, .rst-content table.docutils, .wy-table thead th, .rst-content table.docutils thead th, .rst-content table.field-list thead th, .wy-table-bordered-all td, .rst-content table.docutils td {
+		border-color: gray;
+	}
+
+	img[src$="svg"] {
+		background-color: white;
+		filter: invert(100%) hue-rotate(180deg) saturate(200%);;
+	}
+
+	img[src$="jpg"], img[src$="png"] {
+		border-radius: 5px;
+	}
+
+	.rst-content dl:not(.docutils) dt {
+		background-color: #2D4151;
+	}
+
+	.rst-content dl:not(.docutils) {
+		padding-top: 1em;
+	}
+
+	.rst-content dl:not(.docutils) code.descclassname, .rst-content dl:not(.docutils) code.descname {
+		color:  #ccc;
+	}
+
+	html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt, html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt, .rst-content dl:not(.docutils) dl dt {
+		background-color: #333;
+		color: #ccc;
+	}
+
+	.wy-table caption, .rst-content table.docutils caption, .rst-content table.field-list caption {
+		color: inherit;
+	}
+
+	span.vm, span.nf, span.nn {
+	    color:#66f !important;
+	}
+
+	span.normal {
+		color: #333 !important;
+	}
+
+	td.linenos pre {
+	    background: #ccc !important;
+	}
+
+	.rst-content .highlighted {
+		background-color: #333;
+	}
+}

docs/source/citation.rst

@@ -0,0 +1,21 @@
+Citation
+========
+If you use this code in your research, please cite the repository as follows:
+
+APA
+---
+.. code-block:: 
+
+   Stephenson, M., Mantovani, L., Herrmann, A., & Schaub, H. BSK-RL (Version 0.0.0) [Computer software]. https://github.com/AVSLab/bsk_rl/
+
+BibTeX
+------
+.. code-block:: 
+
+    @software{
+        Stephenson_BSK-RL,
+        author = {Stephenson, Mark and Mantovani, Lorenzzo and Herrmann, Adam and Schaub, Hanspeter},
+        title = {{BSK-RL}},
+        url = {https://github.com/AVSLab/bsk_rl/},
+        version = {0.0.0}
+    }