forked from MirrorHub/synapse
Remove docs/sphinx and related references (#8480)
https://github.com/matrix-org/synapse/tree/develop/docs/sphinx doesn't seem to really be utilised or changed recently since the initial commit. I like the idea of exportable documentation of the codebase, but at the moment after running through the build instructions the generated website wasn't very useful...
This commit is contained in:
Andrew Morgan
GitHub
parent
3cd78bbe9e
commit
01f82bfe32
62 changed files with 1 additions and 839 deletions
13
README.rst
13
README.rst
|
|
@ -290,19 +290,6 @@ Testing with SyTest is recommended for verifying that changes related to the
|
||||||
Client-Server API are functioning correctly. See the `installation instructions
|
Client-Server API are functioning correctly. See the `installation instructions
|
||||||
<https://github.com/matrix-org/sytest#installing>`_ for details.
|
<https://github.com/matrix-org/sytest#installing>`_ for details.
|
||||||
|
|
||||||
Building Internal API Documentation
|
|
||||||
===================================
|
|
||||||
|
|
||||||
Before building internal API documentation install sphinx and
|
|
||||||
sphinxcontrib-napoleon::
|
|
||||||
|
|
||||||
pip install sphinx
|
|
||||||
pip install sphinxcontrib-napoleon
|
|
||||||
|
|
||||||
Building internal API documentation::
|
|
||||||
|
|
||||||
python setup.py build_sphinx
|
|
||||||
|
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
===============
|
===============
|
||||||
|
|
||||||
|
|
|
||||||
1
changelog.d/8480.misc
Normal file
1
changelog.d/8480.misc
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Remove outdated sphinx documentation, scripts and configuration.
|
||||||
|
|
@ -64,8 +64,6 @@ save as it takes a while and is very resource intensive.
|
||||||
- Use underscores for functions and variables.
|
- Use underscores for functions and variables.
|
||||||
- **Docstrings**: should follow the [google code
|
- **Docstrings**: should follow the [google code
|
||||||
style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
|
style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
|
||||||
This is so that we can generate documentation with
|
|
||||||
[sphinx](http://sphinxcontrib-napoleon.readthedocs.org/en/latest/).
|
|
||||||
See the
|
See the
|
||||||
[examples](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
|
[examples](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
|
||||||
in the sphinx documentation.
|
in the sphinx documentation.
|
||||||
|
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
TODO: how (if at all) is this actually maintained?
|
|
||||||
|
|
@ -1,271 +0,0 @@
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
#
|
|
||||||
# Synapse documentation build configuration file, created by
|
|
||||||
# sphinx-quickstart on Tue Jun 10 17:31:02 2014.
|
|
||||||
#
|
|
||||||
# This file is execfile()d with the current directory set to its
|
|
||||||
# containing dir.
|
|
||||||
#
|
|
||||||
# Note that not all possible configuration values are present in this
|
|
||||||
# autogenerated file.
|
|
||||||
#
|
|
||||||
# All configuration values have a default; values that are commented out
|
|
||||||
# serve to show the default.
|
|
||||||
|
|
||||||
import sys
|
|
||||||
import os
|
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
||||||
sys.path.insert(0, os.path.abspath(".."))
|
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here.
|
|
||||||
# needs_sphinx = '1.0'
|
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
||||||
# ones.
|
|
||||||
extensions = [
|
|
||||||
"sphinx.ext.autodoc",
|
|
||||||
"sphinx.ext.intersphinx",
|
|
||||||
"sphinx.ext.coverage",
|
|
||||||
"sphinx.ext.ifconfig",
|
|
||||||
"sphinxcontrib.napoleon",
|
|
||||||
]
|
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
|
||||||
templates_path = ["_templates"]
|
|
||||||
|
|
||||||
# The suffix of source filenames.
|
|
||||||
source_suffix = ".rst"
|
|
||||||
|
|
||||||
# The encoding of source files.
|
|
||||||
# source_encoding = 'utf-8-sig'
|
|
||||||
|
|
||||||
# The master toctree document.
|
|
||||||
master_doc = "index"
|
|
||||||
|
|
||||||
# General information about the project.
|
|
||||||
project = "Synapse"
|
|
||||||
copyright = (
|
|
||||||
"Copyright 2014-2017 OpenMarket Ltd, 2017 Vector Creations Ltd, 2017 New Vector Ltd"
|
|
||||||
)
|
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
|
||||||
# |version| and |release|, also used in various other places throughout the
|
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# The short X.Y version.
|
|
||||||
version = "1.0"
|
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = "1.0"
|
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
||||||
# for a list of supported languages.
|
|
||||||
# language = None
|
|
||||||
|
|
||||||
# There are two options for replacing |today|: either, you set today to some
|
|
||||||
# non-false value, then it is used:
|
|
||||||
# today = ''
|
|
||||||
# Else, today_fmt is used as the format for a strftime call.
|
|
||||||
# today_fmt = '%B %d, %Y'
|
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
|
||||||
# directories to ignore when looking for source files.
|
|
||||||
exclude_patterns = ["_build"]
|
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all
|
|
||||||
# documents.
|
|
||||||
# default_role = None
|
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
||||||
# add_function_parentheses = True
|
|
||||||
|
|
||||||
# If true, the current module name will be prepended to all description
|
|
||||||
# unit titles (such as .. function::).
|
|
||||||
# add_module_names = True
|
|
||||||
|
|
||||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
||||||
# output. They are ignored by default.
|
|
||||||
# show_authors = False
|
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
|
||||||
pygments_style = "sphinx"
|
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
|
||||||
# modindex_common_prefix = []
|
|
||||||
|
|
||||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
|
||||||
# keep_warnings = False
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output ----------------------------------------------
|
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
||||||
# a list of builtin themes.
|
|
||||||
html_theme = "default"
|
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
|
||||||
# further. For a list of options available for each theme, see the
|
|
||||||
# documentation.
|
|
||||||
# html_theme_options = {}
|
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
|
||||||
# html_theme_path = []
|
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to
|
|
||||||
# "<project> v<release> documentation".
|
|
||||||
# html_title = None
|
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
||||||
# html_short_title = None
|
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top
|
|
||||||
# of the sidebar.
|
|
||||||
# html_logo = None
|
|
||||||
|
|
||||||
# The name of an image file (within the static path) to use as favicon of the
|
|
||||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
||||||
# pixels large.
|
|
||||||
# html_favicon = None
|
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
||||||
html_static_path = ["_static"]
|
|
||||||
|
|
||||||
# Add any extra paths that contain custom files (such as robots.txt or
|
|
||||||
# .htaccess) here, relative to this directory. These files are copied
|
|
||||||
# directly to the root of the documentation.
|
|
||||||
# html_extra_path = []
|
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
||||||
# using the given strftime format.
|
|
||||||
# html_last_updated_fmt = '%b %d, %Y'
|
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
||||||
# typographically correct entities.
|
|
||||||
# html_use_smartypants = True
|
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names.
|
|
||||||
# html_sidebars = {}
|
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to
|
|
||||||
# template names.
|
|
||||||
# html_additional_pages = {}
|
|
||||||
|
|
||||||
# If false, no module index is generated.
|
|
||||||
# html_domain_indices = True
|
|
||||||
|
|
||||||
# If false, no index is generated.
|
|
||||||
# html_use_index = True
|
|
||||||
|
|
||||||
# If true, the index is split into individual pages for each letter.
|
|
||||||
# html_split_index = False
|
|
||||||
|
|
||||||
# If true, links to the reST sources are added to the pages.
|
|
||||||
# html_show_sourcelink = True
|
|
||||||
|
|
||||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
||||||
# html_show_sphinx = True
|
|
||||||
|
|
||||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|
||||||
# html_show_copyright = True
|
|
||||||
|
|
||||||
# If true, an OpenSearch description file will be output, and all pages will
|
|
||||||
# contain a <link> tag referring to it. The value of this option must be the
|
|
||||||
# base URL from which the finished HTML is served.
|
|
||||||
# html_use_opensearch = ''
|
|
||||||
|
|
||||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
|
||||||
# html_file_suffix = None
|
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
|
||||||
htmlhelp_basename = "Synapsedoc"
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
|
||||||
|
|
||||||
latex_elements = {
|
|
||||||
# The paper size ('letterpaper' or 'a4paper').
|
|
||||||
#'papersize': 'letterpaper',
|
|
||||||
# The font size ('10pt', '11pt' or '12pt').
|
|
||||||
#'pointsize': '10pt',
|
|
||||||
# Additional stuff for the LaTeX preamble.
|
|
||||||
#'preamble': '',
|
|
||||||
}
|
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
|
||||||
# (source start file, target name, title,
|
|
||||||
# author, documentclass [howto, manual, or own class]).
|
|
||||||
latex_documents = [("index", "Synapse.tex", "Synapse Documentation", "TNG", "manual")]
|
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
|
||||||
# the title page.
|
|
||||||
# latex_logo = None
|
|
||||||
|
|
||||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
|
||||||
# not chapters.
|
|
||||||
# latex_use_parts = False
|
|
||||||
|
|
||||||
# If true, show page references after internal links.
|
|
||||||
# latex_show_pagerefs = False
|
|
||||||
|
|
||||||
# If true, show URL addresses after external links.
|
|
||||||
# latex_show_urls = False
|
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
|
||||||
# latex_appendices = []
|
|
||||||
|
|
||||||
# If false, no module index is generated.
|
|
||||||
# latex_domain_indices = True
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for manual page output ---------------------------------------
|
|
||||||
|
|
||||||
# One entry per manual page. List of tuples
|
|
||||||
# (source start file, name, description, authors, manual section).
|
|
||||||
man_pages = [("index", "synapse", "Synapse Documentation", ["TNG"], 1)]
|
|
||||||
|
|
||||||
# If true, show URL addresses after external links.
|
|
||||||
# man_show_urls = False
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for Texinfo output -------------------------------------------
|
|
||||||
|
|
||||||
# Grouping the document tree into Texinfo files. List of tuples
|
|
||||||
# (source start file, target name, title, author,
|
|
||||||
# dir menu entry, description, category)
|
|
||||||
texinfo_documents = [
|
|
||||||
(
|
|
||||||
"index",
|
|
||||||
"Synapse",
|
|
||||||
"Synapse Documentation",
|
|
||||||
"TNG",
|
|
||||||
"Synapse",
|
|
||||||
"One line description of project.",
|
|
||||||
"Miscellaneous",
|
|
||||||
)
|
|
||||||
]
|
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
|
||||||
# texinfo_appendices = []
|
|
||||||
|
|
||||||
# If false, no module index is generated.
|
|
||||||
# texinfo_domain_indices = True
|
|
||||||
|
|
||||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
|
||||||
# texinfo_show_urls = 'footnote'
|
|
||||||
|
|
||||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
|
||||||
# texinfo_no_detailmenu = False
|
|
||||||
|
|
||||||
|
|
||||||
# Example configuration for intersphinx: refer to the Python standard library.
|
|
||||||
intersphinx_mapping = {"http://docs.python.org/": None}
|
|
||||||
|
|
||||||
napoleon_include_special_with_doc = True
|
|
||||||
napoleon_use_ivar = True
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
.. Synapse documentation master file, created by
|
|
||||||
sphinx-quickstart on Tue Jun 10 17:31:02 2014.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to Synapse's documentation!
|
|
||||||
===================================
|
|
||||||
|
|
||||||
Contents:
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
synapse
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
||||||
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 4
|
|
||||||
|
|
||||||
synapse
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.auth module
|
|
||||||
=======================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.auth
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.constants module
|
|
||||||
============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.constants
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.dbobjects module
|
|
||||||
============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.dbobjects
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.errors module
|
|
||||||
=========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.errors
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.event_stream module
|
|
||||||
===============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.event_stream
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.events.factory module
|
|
||||||
=================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.events.factory
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.events.room module
|
|
||||||
==============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.events.room
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
synapse.api.events package
|
|
||||||
==========================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.api.events.factory
|
|
||||||
synapse.api.events.room
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.events
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.handlers.events module
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.handlers.events
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.handlers.factory module
|
|
||||||
===================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.handlers.factory
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.handlers.federation module
|
|
||||||
======================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.handlers.federation
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.handlers.register module
|
|
||||||
====================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.handlers.register
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.handlers.room module
|
|
||||||
================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.handlers.room
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
synapse.api.handlers package
|
|
||||||
============================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.api.handlers.events
|
|
||||||
synapse.api.handlers.factory
|
|
||||||
synapse.api.handlers.federation
|
|
||||||
synapse.api.handlers.register
|
|
||||||
synapse.api.handlers.room
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.handlers
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.notifier module
|
|
||||||
===========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.notifier
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.register_events module
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.register_events
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.room_events module
|
|
||||||
==============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.room_events
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
synapse.api package
|
|
||||||
===================
|
|
||||||
|
|
||||||
Subpackages
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.api.events
|
|
||||||
synapse.api.handlers
|
|
||||||
synapse.api.streams
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.api.auth
|
|
||||||
synapse.api.constants
|
|
||||||
synapse.api.errors
|
|
||||||
synapse.api.notifier
|
|
||||||
synapse.api.storage
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.api
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.server module
|
|
||||||
=========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.server
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.storage module
|
|
||||||
==========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.storage
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.stream module
|
|
||||||
=========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.stream
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.api.streams.event module
|
|
||||||
================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.streams.event
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
synapse.api.streams package
|
|
||||||
===========================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.api.streams.event
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.api.streams
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.app.homeserver module
|
|
||||||
=============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.app.homeserver
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
synapse.app package
|
|
||||||
===================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.app.homeserver
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.app
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
synapse.db package
|
|
||||||
==================
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.db
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.federation.handler module
|
|
||||||
=================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation.handler
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.federation.messaging module
|
|
||||||
===================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation.messaging
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.federation.pdu_codec module
|
|
||||||
===================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation.pdu_codec
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.federation.persistence module
|
|
||||||
=====================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation.persistence
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.federation.replication module
|
|
||||||
=====================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation.replication
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
synapse.federation package
|
|
||||||
==========================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.federation.handler
|
|
||||||
synapse.federation.pdu_codec
|
|
||||||
synapse.federation.persistence
|
|
||||||
synapse.federation.replication
|
|
||||||
synapse.federation.transport
|
|
||||||
synapse.federation.units
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.federation.transport module
|
|
||||||
===================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation.transport
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.federation.units module
|
|
||||||
===============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.federation.units
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
synapse.persistence package
|
|
||||||
===========================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.persistence.service
|
|
||||||
synapse.persistence.tables
|
|
||||||
synapse.persistence.transactions
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.persistence
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.persistence.service module
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.persistence.service
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.persistence.tables module
|
|
||||||
=================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.persistence.tables
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.persistence.transactions module
|
|
||||||
=======================================
|
|
||||||
|
|
||||||
.. automodule:: synapse.persistence.transactions
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.rest.base module
|
|
||||||
========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.rest.base
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.rest.events module
|
|
||||||
==========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.rest.events
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.rest.register module
|
|
||||||
============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.rest.register
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.rest.room module
|
|
||||||
========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.rest.room
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
synapse.rest package
|
|
||||||
====================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.rest.base
|
|
||||||
synapse.rest.events
|
|
||||||
synapse.rest.register
|
|
||||||
synapse.rest.room
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.rest
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
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:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.server module
|
|
||||||
=====================
|
|
||||||
|
|
||||||
.. automodule:: synapse.server
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.state module
|
|
||||||
====================
|
|
||||||
|
|
||||||
.. automodule:: synapse.state
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.util.async module
|
|
||||||
=========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.util.async
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.util.dbutils module
|
|
||||||
===========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.util.dbutils
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.util.http module
|
|
||||||
========================
|
|
||||||
|
|
||||||
.. automodule:: synapse.util.http
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.util.lockutils module
|
|
||||||
=============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.util.lockutils
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.util.logutils module
|
|
||||||
============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.util.logutils
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
synapse.util package
|
|
||||||
====================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
synapse.util.async
|
|
||||||
synapse.util.http
|
|
||||||
synapse.util.lockutils
|
|
||||||
synapse.util.logutils
|
|
||||||
synapse.util.stringutils
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: synapse.util
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
synapse.util.stringutils module
|
|
||||||
===============================
|
|
||||||
|
|
||||||
.. automodule:: synapse.util.stringutils
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
sphinx-apidoc -o docs/sphinx/ synapse/ -ef
|
|
||||||
|
|
@ -1,8 +1,3 @@
|
||||||
[build_sphinx]
|
|
||||||
source-dir = docs/sphinx
|
|
||||||
build-dir = docs/build
|
|
||||||
all_files = 1
|
|
||||||
|
|
||||||
[trial]
|
[trial]
|
||||||
test_suite = tests
|
test_suite = tests
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue