From 80c362fb652b77525d134e5aae4f67dd1b1a526c Mon Sep 17 00:00:00 2001
From: dequis <dx@dxzone.com.ar>
Date: Mon, 12 Jun 2023 01:07:44 +0200
Subject: [PATCH] who documents the documenters

---
 .gitignore |  3 +++
 README.md  | 16 ++++++++++++++++
 2 files changed, 19 insertions(+)

diff --git a/.gitignore b/.gitignore
index cb706d671b..8e15e6b5f3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,6 @@ __pycache__
 
 # Python
 .venv
+
+# sphinx
+docs/_build/
diff --git a/README.md b/README.md
index 8daba1a408..32bf3861af 100644
--- a/README.md
+++ b/README.md
@@ -248,3 +248,19 @@ Then write and read from each side:
 uart.write("hiiii")
 uart.read(5)
 ```
+
+### Documentation
+
+To build sphinx docs:
+
+```
+cd docs
+make html
+firefox _build/html/index.html
+```
+
+To continuously build on change:
+
+```
+watchexec make html
+```
-- 
GitLab