summary refs log tree commit diff
path: root/docs/sphinx/synapse.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sphinx/synapse.rst')
-rw-r--r--docs/sphinx/synapse.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/sphinx/synapse.rst b/docs/sphinx/synapse.rst
new file mode 100644
index 0000000000..e7869e0e5d
--- /dev/null
+++ b/docs/sphinx/synapse.rst
@@ -0,0 +1,30 @@
+synapse package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    synapse.api
+    synapse.app
+    synapse.federation
+    synapse.persistence
+    synapse.rest
+    synapse.util
+
+Submodules
+----------
+
+.. toctree::
+
+   synapse.server
+   synapse.state
+
+Module contents
+---------------
+
+.. automodule:: synapse
+    :members:
+    :undoc-members:
+    :show-inheritance: