docs: add initial readthedocs documentation

Signed-off-by: Rafael Silva <perigoso@riseup.net>

.readthedocs.yml

@@ -0,0 +1,6 @@
+version: 2
+
+python:
+  version: 3.8
+  install:
+    - requirements: docs/requirements.txt

docs/conf.py

@@ -0,0 +1,66 @@
+# 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:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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.
+
+# -- Project information -----------------------------------------------------
+
+project = 'russian-woodpecker'
+copyright = '2021, Rafael Silva'
+author = 'Rafael Silva'
+
+
+# -- 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',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx_autodoc_typehints',
+    'sphinxemoji.sphinxemoji',
+    'sphinx-pcbdraw',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+}
+
+# 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 = []
+
+# -- 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 = 'furo'
+html_title = 'openinput'
+html_logo = 'assets/logo.svg'
+html_favicon = 'assets/logo_icon.svg'
+html_theme_options = {
+    'sidebar_hide_name': True,
+}
+
+todo_include_todos = True
+
+# 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']
+
+autoclass_content = 'both'

docs/index.rst

@@ -0,0 +1,48 @@
+:hide-toc:
+
+******************
+russian-woodpecker
+******************
+*russian-woodpecker* is a usb HS (capable of 8kHz polling rate) 2.4GHz radio receiver dongle for use with input devices
+
+Specifications
+==============
+
+8 kHz polling rate suppor
+2.4GHz radio
+smol, but not that smol
+
+Hardware
+========
+
+ATSAMS3U MCU as main controller
+nrf52810 MCU as radio receiver
+SPI connection between MCUs
+USB C connector
+External antenna connector
+
+State of the project
+====================
+
+First prototype.
+
+.. admonition:: Roadmap
+
+   - Initial design |:+1:|
+   - First prototype manufactured and assembled |:hammer:|
+   - Barebones firmware support
+   - Documentation |:hammer:|
+   - Hardware improvements / V1
+
+   ========== ================
+   |:+1:|     Done!
+   |:hammer:| Work in progress
+   ========== ================
+
+
+.. toctree::
+   :caption: External Links
+   :hidden:
+
+   Firmware <https://openinput.readthedocs.io>
+   Issue Tracker <https://github.com/openinput-fw/russian-woodpecker/issues>

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx~=3.0
+furo>=2020.12.30.b24
+sphinxemoji>=0.1.8
+sphinx-autodoc-typehints>=1.10