patx/micropie
push built docs view at patx.github.io/micropie/build/html
Commit 21f3d09 · patx · 2025-08-15T02:11:42-04:00
Comments
No comments yet.
Diff
diff --git a/docs/apidocs/conf.py b/docs/apidocs/conf.py
new file mode 100644
index 0000000..c2bfb74
--- /dev/null
+++ b/docs/apidocs/conf.py
@@ -0,0 +1,24 @@
+# Configuration file for the Sphinx documentation builder.
+
+project = "MicroPie"
+author = "Harrison Erd"
+release = "0.20"
+
+extensions = [
+ "sphinx.ext.autodoc",
+ "sphinx.ext.viewcode",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# Theme settings
+html_theme = "alabaster"
+html_theme_options = {
+ "description": "A minimal ASGI web framework",
+ "github_user": "patx",
+ "github_repo": "micropie",
+ "fixed_sidebar": True,
+}
+html_static_path = ["_static"]
+
diff --git a/docs/docs/explanation/architecture.rst b/docs/apidocs/explanation/architecture.rst
similarity index 100%
rename from docs/docs/explanation/architecture.rst
rename to docs/apidocs/explanation/architecture.rst
diff --git a/docs/docs/explanation/index.rst b/docs/apidocs/explanation/index.rst
similarity index 100%
rename from docs/docs/explanation/index.rst
rename to docs/apidocs/explanation/index.rst
diff --git a/docs/docs/glossary.rst b/docs/apidocs/glossary.rst
similarity index 100%
rename from docs/docs/glossary.rst
rename to docs/apidocs/glossary.rst
diff --git a/docs/docs/howto/index.rst b/docs/apidocs/howto/index.rst
similarity index 100%
rename from docs/docs/howto/index.rst
rename to docs/apidocs/howto/index.rst
diff --git a/docs/docs/howto/middleware.rst b/docs/apidocs/howto/middleware.rst
similarity index 100%
rename from docs/docs/howto/middleware.rst
rename to docs/apidocs/howto/middleware.rst
diff --git a/docs/docs/howto/sessions.rst b/docs/apidocs/howto/sessions.rst
similarity index 100%
rename from docs/docs/howto/sessions.rst
rename to docs/apidocs/howto/sessions.rst
diff --git a/docs/docs/howto/socketio.rst b/docs/apidocs/howto/socketio.rst
similarity index 100%
rename from docs/docs/howto/socketio.rst
rename to docs/apidocs/howto/socketio.rst
diff --git a/docs/docs/howto/static_files.rst b/docs/apidocs/howto/static_files.rst
similarity index 100%
rename from docs/docs/howto/static_files.rst
rename to docs/apidocs/howto/static_files.rst
diff --git a/docs/docs/howto/streaming.rst b/docs/apidocs/howto/streaming.rst
similarity index 100%
rename from docs/docs/howto/streaming.rst
rename to docs/apidocs/howto/streaming.rst
diff --git a/docs/docs/howto/templates.rst b/docs/apidocs/howto/templates.rst
similarity index 100%
rename from docs/docs/howto/templates.rst
rename to docs/apidocs/howto/templates.rst
diff --git a/docs/docs/index.rst b/docs/apidocs/index.rst
similarity index 100%
rename from docs/docs/index.rst
rename to docs/apidocs/index.rst
diff --git a/docs/docs/reference/app.rst b/docs/apidocs/reference/app.rst
similarity index 100%
rename from docs/docs/reference/app.rst
rename to docs/apidocs/reference/app.rst
diff --git a/docs/docs/reference/exceptions.rst b/docs/apidocs/reference/exceptions.rst
similarity index 100%
rename from docs/docs/reference/exceptions.rst
rename to docs/apidocs/reference/exceptions.rst
diff --git a/docs/docs/reference/index.rst b/docs/apidocs/reference/index.rst
similarity index 78%
rename from docs/docs/reference/index.rst
rename to docs/apidocs/reference/index.rst
index 40095d3..6cc8567 100644
--- a/docs/docs/reference/index.rst
+++ b/docs/apidocs/reference/index.rst
@@ -3,7 +3,7 @@ API reference
The reference manual provides detailed descriptions of the classes and
functions exposed by MicroPie. These documents are factual and
-succinct【730263613588085†L336-L339】. For tutorials and recipes, see the
+succinct. For tutorials and recipes, see the
:doc:`../tutorial/index` and :doc:`../howto/index` sections.
.. toctree::
@@ -15,4 +15,4 @@ succinct【730263613588085†L336-L339】. For tutorials and recipes, see the
websocket
middleware
session
- exceptions
\ No newline at end of file
+ exceptions
diff --git a/docs/docs/reference/middleware.rst b/docs/apidocs/reference/middleware.rst
similarity index 100%
rename from docs/docs/reference/middleware.rst
rename to docs/apidocs/reference/middleware.rst
diff --git a/docs/docs/reference/request.rst b/docs/apidocs/reference/request.rst
similarity index 100%
rename from docs/docs/reference/request.rst
rename to docs/apidocs/reference/request.rst
diff --git a/docs/docs/reference/session.rst b/docs/apidocs/reference/session.rst
similarity index 100%
rename from docs/docs/reference/session.rst
rename to docs/apidocs/reference/session.rst
diff --git a/docs/docs/reference/websocket.rst b/docs/apidocs/reference/websocket.rst
similarity index 100%
rename from docs/docs/reference/websocket.rst
rename to docs/apidocs/reference/websocket.rst
diff --git a/docs/docs/tutorial/index.rst b/docs/apidocs/tutorial/index.rst
similarity index 100%
rename from docs/docs/tutorial/index.rst
rename to docs/apidocs/tutorial/index.rst
diff --git a/docs/docs/tutorial/quickstart.rst b/docs/apidocs/tutorial/quickstart.rst
similarity index 100%
rename from docs/docs/tutorial/quickstart.rst
rename to docs/apidocs/tutorial/quickstart.rst
diff --git a/docs/docs/tutorial/routing.rst b/docs/apidocs/tutorial/routing.rst
similarity index 100%
rename from docs/docs/tutorial/routing.rst
rename to docs/apidocs/tutorial/routing.rst
diff --git a/docs/docs/tutorial/websockets.rst b/docs/apidocs/tutorial/websockets.rst
similarity index 100%
rename from docs/docs/tutorial/websockets.rst
rename to docs/apidocs/tutorial/websockets.rst