summaryrefslogtreecommitdiff
path: root/sphinx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'sphinx/README.md')
-rw-r--r--sphinx/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/sphinx/README.md b/sphinx/README.md
new file mode 100644
index 0000000..813f05d
--- /dev/null
+++ b/sphinx/README.md
@@ -0,0 +1,27 @@
+# Sphinx Documentation Builder
+
+This directory contains the Sphinx configuration for generating API documentation from Python docstrings.
+
+## Building Documentation
+
+To build the HTML documentation:
+
+```bash
+cd sphinx
+make html
+```
+
+The generated documentation will be in `sphinx/build/html/`.
+
+## Requirements
+
+Install Sphinx dependencies:
+
+```bash
+pip install -r sphinx/requirements.txt
+```
+
+## Read the Docs
+
+This configuration is used by Read the Docs for automated documentation builds.
+