working on docs

.gitignore

@@ -1,4 +1,5 @@
-dist/*
+/dist/
+/venv/
 .vscode
 .clang-format
 .clangd

Makefile

@@ -14,6 +14,6 @@ launch: build
 clean:
 	ufbt -c
 
-.PHONY: publish
-publish: build
-	./publish.sh fap-release
+.PHONY: pages
+pages:
+	source venv/bin/activate && sphinx-build docs/pages dist/pages

docs/pages/conf.py

@@ -0,0 +1,37 @@
+project = 'uPython'
+copyright = '2024, Oliver Fabel'
+author = 'Oliver Fabel'
+release = '1.0.0'
+language = 'en'
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'myst_parser'
+]
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown'
+}
+
+templates_path = [
+    'templates'
+]
+exclude_patterns = []
+include_patterns = [
+    '**'
+]
+
+html_theme = 'alabaster'
+html_theme_options = {
+    'extra_nav_links': {
+        'Source Code': 'https://www.github.com/ofabel/mp-flipper',
+        'Bugtracker': 'https://www.github.com/ofabel/mp-flipper/issues',
+        'Releases': 'https://lab.flipper.net/apps/upython'
+
+    }
+}
+html_static_path = [
+    'static'
+]
+html_logo = 'assets/logo.png'
+html_favicon = 'assets/favicon.png'

docs/pages/index.rst

@@ -0,0 +1,48 @@
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   quickstart
+   installation
+   users-guide
+   best-practice
+   architecture
+   reference
+   Changes </changes>
+   License </license>
+
+MicroPython on Flipper Zero
+===========================
+
+.. image:: https://img.shields.io/github/license/ofabel/mp-flipper
+   :alt: License
+
+.. image:: https://img.shields.io/github/v/tag/ofabel/mp-flipper
+   :alt: Version
+
+.. image:: https://img.shields.io/github/issues/ofabel/mp-flipper
+   :alt: Issues
+
+A `MicroPython <https://github.com/micropython/micropython>`_ port for the famous `Flipper Zero <https://flipperzero.one/>`_.
+No need to learn C: Use your favourite programming language to create apps, games and scripts.
+
+Features
+--------
+
+* Support for basic language constructs like functions, classes, loops, ...
+* Access the Flipper's hardware: buttons, speaker, LED & screen light, ...
+* No custom firmware required, so no risk to brick your Flipper.
+
+How to Start
+------------
+
+1. Install the application from the `Flipper Lab <https://lab.flipper.net/apps/upython>`_ on your Flipper device.
+2. Write some Python code or use one of the provided examples.
+3. Use the `qFlipper <https://flipperzero.one/update>`_ application to upload the code to your Flipper's SD card.
+4. Use the **uPython** application on your Flipper to execute your Python script.
+
+License
+-------
+
+The uPython application is published under the :doc:`MIT </license>` license.
+

docs/pages/license.rst

@@ -0,0 +1 @@
+.. include:: ../../LICENSE.txt

requirements.txt

@@ -0,0 +1,2 @@
+Sphinx==8.0.2
+myst-parser==4.0.0