Docs notes

zimeon · Nov 6, 2024 · 6b77a59 · 6b77a59
1 parent b8acef1
commit 6b77a59
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/DEV_NOTES.md b/DEV_NOTES.md
@@ -0,0 +1,14 @@
+# Development Notes
+
+## Testing Sphinx documentation build
+
+```
+> sphinx-autobuild docs docs/_build
+```
+
+Then access <http://127.0.0.1:8000/>
+
+Some RTD examples using sphinx:
+* <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html>
+* <https://simpy.readthedocs.io/en/latest/index.html>
+* <https://apt-team.pages.debian.net/python-apt/library/index.html>