Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SYNPY-1213, SYNPY-1245] Improve doc site #946

Merged
merged 53 commits into from Aug 13, 2023
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
4875ef6
Use rtd theme for doc site
thomasyu888 Aug 6, 2022
f4461c5
Update documentation
thomasyu888 Aug 7, 2022
2036393
Add doc requirements
thomasyu888 Aug 7, 2022
7e38c87
Add readthedocs yaml
thomasyu888 Aug 7, 2022
cae7255
Fix path
thomasyu888 Aug 7, 2022
37b030a
fix path
thomasyu888 Aug 7, 2022
5375b84
Unpin versions
thomasyu888 Aug 7, 2022
d45ce6a
Fix sphinx warnings
thomasyu888 Aug 7, 2022
16405c5
Update documentation title
thomasyu888 Aug 7, 2022
682b951
Reorganize documentation
thomasyu888 Aug 8, 2022
8dd6357
Re-organize docs
thomasyu888 Aug 8, 2022
28dfd20
update installation guide
thomasyu888 Aug 8, 2022
fd50472
Add headers
thomasyu888 Aug 8, 2022
49396b5
Update doc
thomasyu888 Aug 8, 2022
7178fa8
Fix merge conflicts
thomasyu888 Mar 6, 2023
bd34e02
Add docs
thomasyu888 Mar 6, 2023
e4492f5
Fix merge conflict
thomasyu888 Jun 3, 2023
3c90d96
Refresh build
thomasyu888 Jun 3, 2023
bdc97e2
Add in custom css
thomasyu888 Jun 3, 2023
61be49b
Fix merge conflicts
thomasyu888 Jun 3, 2023
a12f140
Update
thomasyu888 Jun 3, 2023
449b372
Merge branch 'develop' into improve-doc-site
thomasyu888 Jun 5, 2023
b0a8904
Edit credentials
thomasyu888 Jun 5, 2023
4d2f552
Merge branch 'develop' into improve-doc-site
thomasyu888 Jul 2, 2023
e764247
Improve readme
thomasyu888 Jul 2, 2023
a447a9d
Fix merge conflicts
thomasyu888 Jul 2, 2023
67b0a9a
Update documentation
thomasyu888 Jul 2, 2023
dc3d1ff
Polish documentation
thomasyu888 Jul 2, 2023
87cd2d6
Clean up documentation
thomasyu888 Jul 2, 2023
fe4201f
Fix any doc rendering issues
thomasyu888 Jul 2, 2023
fa608cb
SYNPY-1213-add-user-groups
thomasyu888 Jul 2, 2023
7e6b04c
Update documentation links
thomasyu888 Jul 2, 2023
d2ece24
Update documentation links
thomasyu888 Jul 2, 2023
574c0a0
Update links to new docs
thomasyu888 Jul 2, 2023
5230c0b
Use new synapse doc links
thomasyu888 Jul 2, 2023
7122eb3
Update old doc links
thomasyu888 Jul 2, 2023
4613089
Update documentation with new doc links
thomasyu888 Jul 2, 2023
b4e6057
Modify multi part upload
thomasyu888 Jul 14, 2023
af462b4
Build html
thomasyu888 Jul 14, 2023
821135c
Update credentials
thomasyu888 Jul 15, 2023
406fdec
Update client docs
thomasyu888 Jul 15, 2023
ca93e25
Shift command line client to articles
thomasyu888 Jul 15, 2023
f79020f
Re-order documentation
thomasyu888 Jul 15, 2023
8effdeb
Add new articles
thomasyu888 Jul 15, 2023
4176622
Add new docs
thomasyu888 Jul 15, 2023
b7deb4c
Update docs
thomasyu888 Jul 15, 2023
94de437
Add api rst
thomasyu888 Jul 15, 2023
2866431
Add tables and permissions
thomasyu888 Jul 16, 2023
d12df77
Simplify tutorial
thomasyu888 Jul 16, 2023
9e1b1b9
Add files
thomasyu888 Jul 16, 2023
3b1cdd2
Simplify article
thomasyu888 Jul 16, 2023
f7dd3ae
Make title consistent
thomasyu888 Jul 16, 2023
be40291
Combine core modules
thomasyu888 Jul 16, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 29 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,29 @@
# .readthedocs.yaml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only for testing purposes

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
8 changes: 2 additions & 6 deletions docs/CommandLineClient.rst
@@ -1,14 +1,10 @@
***************************
Synapse command line client
***************************

The Synapse Python Client can be used from the command line via the **synapse** command.

Installation
============

The command line client is installed along with `installation of the Synapse Python client \
<http://python-docs.synapse.org/build/html/index.html#installation>`_.
The command line client is installed along with :doc:`getting_started/installation` of the Synapse Python client.


Help
====
Expand Down
28 changes: 2 additions & 26 deletions docs/_static/custom.css
@@ -1,27 +1,3 @@
@import url("bizstyle.css");

html * {
font-family: Lato, Sans-Serif;
}

div.header {
background-color: white;
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
text-align: center;
height: 55px;
padding-left: 2em;
padding-right: 200px;
}

div.header img {
float:left;
}

.deprecated {
background-color: #FFFF00
}

table.field-list th {
word-break: normal;
.wy-side-nav-search, .wy-nav-top {
background-color: #303366;
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4be5d359e1e0328de5e4c362b4415eae
config: 03db8eb10315b48babf7b4b59cd81f48
tags: 645f666f9bcd5a90fca523b33c5a78b7
778 changes: 396 additions & 382 deletions docs/build/html/CommandLineClient.html

Large diffs are not rendered by default.

209 changes: 124 additions & 85 deletions docs/build/html/Multipart_upload.html

Large diffs are not rendered by default.

261 changes: 127 additions & 134 deletions docs/build/html/S3Storage.html

Large diffs are not rendered by default.

244 changes: 123 additions & 121 deletions docs/build/html/Upload.html

Large diffs are not rendered by default.

167 changes: 0 additions & 167 deletions docs/build/html/Versions.html

This file was deleted.