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
thomasyu888
merged 53 commits into
Sage-Bionetworks:develop
from
thomasyu888:improve-doc-site
Aug 13, 2023
Merged
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 f4461c5
Update documentation
thomasyu888 2036393
Add doc requirements
thomasyu888 7e38c87
Add readthedocs yaml
thomasyu888 cae7255
Fix path
thomasyu888 37b030a
fix path
thomasyu888 5375b84
Unpin versions
thomasyu888 d45ce6a
Fix sphinx warnings
thomasyu888 16405c5
Update documentation title
thomasyu888 682b951
Reorganize documentation
thomasyu888 8dd6357
Re-organize docs
thomasyu888 28dfd20
update installation guide
thomasyu888 fd50472
Add headers
thomasyu888 49396b5
Update doc
thomasyu888 7178fa8
Fix merge conflicts
thomasyu888 bd34e02
Add docs
thomasyu888 e4492f5
Fix merge conflict
thomasyu888 3c90d96
Refresh build
thomasyu888 bdc97e2
Add in custom css
thomasyu888 61be49b
Fix merge conflicts
thomasyu888 a12f140
Update
thomasyu888 449b372
Merge branch 'develop' into improve-doc-site
thomasyu888 b0a8904
Edit credentials
thomasyu888 4d2f552
Merge branch 'develop' into improve-doc-site
thomasyu888 e764247
Improve readme
thomasyu888 a447a9d
Fix merge conflicts
thomasyu888 67b0a9a
Update documentation
thomasyu888 dc3d1ff
Polish documentation
thomasyu888 87cd2d6
Clean up documentation
thomasyu888 fe4201f
Fix any doc rendering issues
thomasyu888 fa608cb
SYNPY-1213-add-user-groups
thomasyu888 7e6b04c
Update documentation links
thomasyu888 d2ece24
Update documentation links
thomasyu888 574c0a0
Update links to new docs
thomasyu888 5230c0b
Use new synapse doc links
thomasyu888 7122eb3
Update old doc links
thomasyu888 4613089
Update documentation with new doc links
thomasyu888 b4e6057
Modify multi part upload
thomasyu888 af462b4
Build html
thomasyu888 821135c
Update credentials
thomasyu888 406fdec
Update client docs
thomasyu888 ca93e25
Shift command line client to articles
thomasyu888 f79020f
Re-order documentation
thomasyu888 8effdeb
Add new articles
thomasyu888 4176622
Add new docs
thomasyu888 b7deb4c
Update docs
thomasyu888 94de437
Add api rst
thomasyu888 2866431
Add tables and permissions
thomasyu888 d12df77
Simplify tutorial
thomasyu888 9e1b1b9
Add files
thomasyu888 3b1cdd2
Simplify article
thomasyu888 f7dd3ae
Make title consistent
thomasyu888 be40291
Combine core modules
thomasyu888 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# .readthedocs.yaml | ||
# 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: | ||
|
||
# Optionally declare the Python requirements required to build your docs | ||
python: | ||
install: | ||
- requirements: docs/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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