Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Remove docs/sphinx and related references #8480

Merged
merged 2 commits into from
Oct 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<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
===============

Expand Down
1 change: 1 addition & 0 deletions changelog.d/8480.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove outdated sphinx documentation, scripts and configuration.
2 changes: 0 additions & 2 deletions docs/code_style.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ save as it takes a while and is very resource intensive.
- Use underscores for functions and variables.
- **Docstrings**: should follow the [google code
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
[examples](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
in the sphinx documentation.
Expand Down
1 change: 0 additions & 1 deletion docs/sphinx/README.rst

This file was deleted.

271 changes: 0 additions & 271 deletions docs/sphinx/conf.py

This file was deleted.

20 changes: 0 additions & 20 deletions docs/sphinx/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/modules.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/synapse.api.auth.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/synapse.api.constants.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/synapse.api.dbobjects.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/synapse.api.errors.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/synapse.api.event_stream.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/synapse.api.events.factory.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/sphinx/synapse.api.events.room.rst

This file was deleted.

Loading