summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile20
l---------docs/README.md1
l---------docs/TODO.md1
-rw-r--r--docs/conf.py59
-rw-r--r--docs/index.rst23
l---------docs/res1
-rw-r--r--docs/wasp.rst30
7 files changed, 135 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..ed88099
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# 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 = .
+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
new file mode 120000
index 0000000..32d46ee
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1 @@
+../README.md \ No newline at end of file
diff --git a/docs/TODO.md b/docs/TODO.md
new file mode 120000
index 0000000..15d039a
--- /dev/null
+++ b/docs/TODO.md
@@ -0,0 +1 @@
+../TODO.md \ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..957072a
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,59 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../wasp'))
+sys.path.insert(0, os.path.abspath('../wasp/boards/simulator'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'WASP-OS'
+copyright = '2020, Daniel Thompson'
+author = 'Daniel Thompson'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'recommonmark',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+#templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+source_suffix = {
+ '.rst': 'restructuredtext',
+ '.md': 'markdown',
+}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..84c9765
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,23 @@
+.. WASP-OS documentation master file, created by
+ sphinx-quickstart on Sat Feb 22 20:30:29 2020.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to WASP-OS's documentation!
+===================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ README
+ wasp
+ TODO
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/res b/docs/res
new file mode 120000
index 0000000..dbbfe3c
--- /dev/null
+++ b/docs/res
@@ -0,0 +1 @@
+../res/ \ No newline at end of file
diff --git a/docs/wasp.rst b/docs/wasp.rst
new file mode 100644
index 0000000..4c0c0ff
--- /dev/null
+++ b/docs/wasp.rst
@@ -0,0 +1,30 @@
+WASP Internals
+==============
+
+System management
+-----------------
+
+.. automodule:: manager
+ :members:
+ :undoc-members:
+
+Applications
+------------
+
+.. automodule:: clock
+ :members:
+ :undoc-members:
+
+Device drivers
+--------------
+
+.. automodule:: drivers.st7789
+ :members:
+ :undoc-members:
+
+Libraries
+---------
+
+.. automodule:: draw565
+ :members:
+ :undoc-members: