dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-10-15 02:22:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove docs/sphinx and related references (#8480)

Browse Source 
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
2020-10-07 11:45:31 +01:00
committed by GitHub
parent 3cd78bbe9e
commit 01f82bfe32
62 changed files with 1 additions and 839 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/code_style.md
-2
View File
@@ -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.