diff options
author | Erik Johnston <erikj@element.io> | 2024-05-01 17:01:50 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-05-01 16:01:50 +0000 |
commit | 0b358f8643bcec9263d115303ace92e6980d2c6f (patch) | |
tree | 3a91d6830de6eedb219b7f7a6a5f99f20800060c /dev-docs | |
parent | Correct licensing metadata on the Docker image (#17141) (diff) | |
download | synapse-0b358f8643bcec9263d115303ace92e6980d2c6f.tar.xz |
Drop sphinx docs (#17073)
It is broken, and we only seemed to have been building it for the federation sender. Closes https://github.com/element-hq/synapse/issues/16804
Diffstat (limited to 'dev-docs')
-rw-r--r-- | dev-docs/Makefile | 20 | ||||
-rw-r--r-- | dev-docs/conf.py | 50 | ||||
-rw-r--r-- | dev-docs/index.rst | 22 | ||||
-rw-r--r-- | dev-docs/modules/federation_sender.md | 5 |
4 files changed, 0 insertions, 97 deletions
diff --git a/dev-docs/Makefile b/dev-docs/Makefile deleted file mode 100644 index d4bb2cbb9e..0000000000 --- a/dev-docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/dev-docs/conf.py b/dev-docs/conf.py deleted file mode 100644 index 826d578c0b..0000000000 --- a/dev-docs/conf.py +++ /dev/null @@ -1,50 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = "Synapse development" -copyright = "2023, The Matrix.org Foundation C.I.C." -author = "The Synapse Maintainers and Community" - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = [ - "autodoc2", - "myst_parser", -] - -templates_path = ["_templates"] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - - -# -- Options for Autodoc2 ---------------------------------------------------- - -autodoc2_docstring_parser_regexes = [ - # this will render all docstrings as 'MyST' Markdown - (r".*", "myst"), -] - -autodoc2_packages = [ - { - "path": "../synapse", - # Don't render documentation for everything as a matter of course - "auto_mode": False, - }, -] - - -# -- Options for MyST (Markdown) --------------------------------------------- - -# myst_heading_anchors = 2 - - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = "furo" -html_static_path = ["_static"] diff --git a/dev-docs/index.rst b/dev-docs/index.rst deleted file mode 100644 index 1ef210460a..0000000000 --- a/dev-docs/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. 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` diff --git a/dev-docs/modules/federation_sender.md b/dev-docs/modules/federation_sender.md deleted file mode 100644 index dac6852c16..0000000000 --- a/dev-docs/modules/federation_sender.md +++ /dev/null @@ -1,5 +0,0 @@ -Federation Sender -================= - -```{autodoc2-docstring} synapse.federation.sender -``` |