Add configuration files for Sphinx/ReadTheDocs

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats: all
+
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/build-flash-and-debug/index.md

@@ -0,0 +1,33 @@
+# Build, flash and debug
+## Project branches
+## Versioning
+## Files included in the release notes
+## Build the project
+## Build the documentation
+### Setup
+The documentation is written in Makrdown (.md) files and generated using the Sphinx documentation generator.
+
+First, we need to install Sphinx and its dependencies:
+ - `myst-parser` : add support for markdown files
+ - `sphinx_rtd_theme` : theme from ReadTheDocs
+```
+pip install sphinx
+pip install myst-parser
+pip install sphinx_rtd_theme
+```
+
+### Build the doc
+Run the following command in the folder `docs`
+```
+sphinx-build -b html ./ ./generated
+```
+
+Then display the doc by browsing to `generated/index.html` using your favorite web browser.
+
+## Flash the firmware using OpenOCD and STLinkV2
+## Build the project with Docker
+## Build the project with VSCode
+## Bootloader, OTA and DFU
+## Stub using NRF52-DK
+## Logging with JLink RTT
+## Using files from the releases

docs/conf.py

@@ -0,0 +1,39 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'InfiniTime'
+copyright = '2021, InfiniTime'
+author = 'InfiniTime'
+
+release = '1.7'
+version = '1.7.1'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    'myst_parser',
+]
+
+source_suffix = ['.md']
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'
+

docs/credits.md

@@ -0,0 +1 @@
+# Credits

docs/developer-documentation/index.md

@@ -0,0 +1,6 @@
+# Developer documentation
+## Rough structure of the code
+## How to implement an app
+## Generating the fonts and symbols
+## Creating a stopwatch in PineTime (article)
+## BLE implementation and API

docs/going-further.md

@@ -0,0 +1,5 @@
+# Going further
+* The [PineTime wiki](https://wiki.pine64.org/wiki/PineTime)
+* InfiniTime resources from other people
+  * Videos
+  * Articles

docs/how-to-contribute.md

@@ -0,0 +1 @@
+# How to contribute

docs/index.md

@@ -0,0 +1,12 @@
+# InfiniTime
+
+```{toctree}
+what-is-infinitime/index.md
+user-documentation/index.md
+developer-documentation/index.md
+build-flash-and-debug/index.md
+how-to-contribute.md
+going-further.md
+licences.md
+credits.md
+```

docs/licences.md

@@ -0,0 +1 @@
+# Licences

docs/requirements.txt

@@ -0,0 +1 @@
+myst-parser

docs/setup.cfg

@@ -0,0 +1,4 @@
+[options.extras_require]
+docs =
+    sphinx
+    myst-parser

docs/user-documentation/index.md

@@ -0,0 +1,20 @@
+# User documentation
+## Getting started with InfiniTime
+### Unboxing your PineTime
+### Boot/Reboot/Switch off InfiniTime
+### Setting up date and time
+#### Manually
+#### Using companion apps
+#### Using any Chromium-based web-browser
+#### Using NRFConnectr
+### Companion apps
+### The InfiniTime UI
+## Flash And Upgrade
+### Firmware, bootloader, recovery firmware
+### Upgrading your PineTime
+#### Over-The-Air (OTA)
+#### Using Gadgetbridge
+#### Using Amazfish
+#### Using NRFConnect
+### Using the SWD interface
+## Firmware validation

docs/what-is-infinitime/index.md

@@ -0,0 +1,7 @@
+# What is InfiniTime
+## Generalities about PineTime
+## InfiniTime goals
+## InfiniTime features - high level
+## InfiniTime history
+### Project history
+### Firmwares history and changelog