summary refs log tree commit diff
path: root/dev-docs/index.rst
diff options
context:
space:
mode:
authorreivilibre <oliverw@matrix.org>2023-03-24 16:41:10 +0000
committerGitHub <noreply@github.com>2023-03-24 16:41:10 +0000
commitd5324ee111ea56fa466eab7e3974dc4894a64d46 (patch)
treeff7b2523083d585eea3e8f4548c96634f4fb0192 /dev-docs/index.rst
parentAs an optimisation, use `TRUNCATE` on Postgres when clearing the user directo... (diff)
downloadsynapse-d5324ee111ea56fa466eab7e3974dc4894a64d46.tar.xz
Add developer documentation for the Federation Sender and add a documentation mechanism using Sphinx. (#15265)
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to 'dev-docs/index.rst')
-rw-r--r--dev-docs/index.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/dev-docs/index.rst b/dev-docs/index.rst
new file mode 100644
index 0000000000..1ef210460a
--- /dev/null
+++ b/dev-docs/index.rst
@@ -0,0 +1,22 @@
+.. Synapse Developer Documentation documentation master file, created by
+   sphinx-quickstart on Mon Mar 13 08:59:51 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to the Synapse Developer Documentation!
+===========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules/federation_sender
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`