summary refs log tree commit diff
diff options
context:
space:
mode:
authorTill <2353100+S7evinK@users.noreply.github.com>2024-06-26 18:01:39 +0200
committerGitHub <noreply@github.com>2024-06-26 18:01:39 +0200
commitb924a8e1a9c3772abf1d19602cfc52591bc6bc62 (patch)
tree4c1a258f5e1bc9d23798c9850512d57205da3465
parentFixes to the table of contents in the README (#17329) (diff)
downloadsynapse-b924a8e1a9c3772abf1d19602cfc52591bc6bc62.tar.xz
Fix uploading packages to PyPi (#17363)
As per
https://github.com/sphinx-doc/sphinx/issues/3921#issuecomment-315581557,
we need double underscores.
Running `rst2html README.rst > /dev/null` found some more warnings.
-rw-r--r--README.rst14
-rw-r--r--changelog.d/17363.misc1
2 files changed, 8 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 145315a7fe..9ecb6b5816 100644
--- a/README.rst
+++ b/README.rst
@@ -5,9 +5,9 @@
 
 |support| |development| |documentation| |license| |pypi| |python|
 
-Synapse is an open source `Matrix <https://matrix.org>`_ homeserver
+Synapse is an open source `Matrix <https://matrix.org>`__ homeserver
 implementation, written and maintained by `Element <https://element.io>`_.
-`Matrix <https://github.com/matrix-org>`_ is the open standard for
+`Matrix <https://github.com/matrix-org>`__ is the open standard for
 secure and interoperable real time communications. You can directly run
 and manage the source code in this repository, available under an AGPL
 license. There is no support provided from Element unless you have a
@@ -119,7 +119,7 @@ impact to other applications will be minimal.
 
 
 ๐Ÿงช Testing a new installation
-============================
+=============================
 
 The easiest way to try out your new Synapse installation is by connecting to it
 from a web client.
@@ -173,10 +173,10 @@ As when logging in, you will need to specify a "Custom server".  Specify your
 desired ``localpart`` in the 'User name' box.
 
 ๐ŸŽฏ Troubleshooting and support
-=============================
+==============================
 
 ๐Ÿš€ Professional support
-----------------------
+-----------------------
 
 Enterprise quality support for Synapse including SLAs is available as part of an
 `Element Server Suite (ESS) <https://element.io/pricing>` subscription.
@@ -185,7 +185,7 @@ If you are an existing ESS subscriber then you can raise a `support request <htt
 and access the `knowledge base <https://ems-docs.element.io>`.
 
 ๐Ÿค Community support
--------------------
+--------------------
 
 The `Admin FAQ <https://element-hq.github.io/synapse/latest/usage/administration/admin_faq.html>`_
 includes tips on dealing with some common problems. For more details, see
@@ -202,7 +202,7 @@ issues for support requests, only for bug reports and feature requests.
 .. _docs: docs
 
 ๐Ÿชช Identity Servers
-==================
+===================
 
 Identity servers have the job of mapping email addresses and other 3rd Party
 IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs
diff --git a/changelog.d/17363.misc b/changelog.d/17363.misc
new file mode 100644
index 0000000000..555e2225ba
--- /dev/null
+++ b/changelog.d/17363.misc
@@ -0,0 +1 @@
+Fix uploading packages to PyPi.
\ No newline at end of file