Add base for RTD documentation #130

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/conf.py

docs/conf.py

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+source_encoding = 'utf-8'
+master_doc = 'index'
+
+extensions = ['myst_parser']
+myst_enable_extensions = ['colon_fence', 'strikethrough']
+
+project = 'enioka Scan'
+copyright = '2012-2020, enioka Haute Couture'
+#version = '2.4'
+#release = '2.4.1'
+hightlight_language = 'java'
+
+html_theme = 'sphinx_rtd_theme'

docs/index.md

@@ -0,0 +1,29 @@
+# enioka Haute Couture Android Barcode Scanning Library
+
+This library makes the integration of all barcode scanners easy in any Android application,
+avoiding vendor lock-in and lowering the cost of advanced scanner integration.
+
+It is compatible with:
+- Zebra EMDK devices (which comprise most of their integrated systems like the TC25, TC75, WT6000...)
+- Zebra Bluetooth scanners
+- Honeywell AIDC integrated devices (including CN* devices)
+- Athesi SPA43
+- GeneralScan Bluetooth rings
+- And a few others, check full compatibility table below.
+
+When there are no compatible hardware devices available, the library provides a camera reader based on ZBar (default) or ZXing.
+
+Through a common abstraction, it provides access to the following methods (provided the hardware supports them):
+- press/release the scanner's trigger
+- pause/resume scanning abilities
+- disconnect/reconnect scanners
+- enable/disable illumination from the scanner
+- enable/disable colored LEDs
+- set scanner enabled symbologies
+
+Finally, it provides a ready to use Service that handles scanner lifecycles, as well as a template Activity, and a sample demo
+application, allowing to use scanners in a matter of minutes.
+
+:::{WIP}
+This documentation is a work in progress.
+:::

docs/requirements.txt

@@ -0,0 +1,3 @@
+myst-parser==2.0.0
+sphinx==7.2.6
+sphinx-rtd-theme==2.0.0