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

Add developer documentation for the Federation Sender and add a documentation mechanism using Sphinx. #15265

Merged
merged 20 commits into from
Mar 24, 2023
Merged

Add developer documentation for the Federation Sender and add a documentation mechanism using Sphinx. #15265

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a517600
Set up a Sphinx site in `dev-docs`
reivilibre Mar 13, 2023
1b23a6a
Enable autodoc extension in Sphinx
reivilibre Mar 13, 2023
8db5e35
Start off an example of how to document a module
reivilibre Mar 13, 2023
11cfb3e
Switch to autodoc2 and MyST (Markdown)
reivilibre Mar 14, 2023
b5b7070
Write up documentation about Federation Sending
reivilibre Mar 14, 2023
7f96f0d
Add a GH workflow for developer documentation
reivilibre Mar 14, 2023
cce451b
Newsfile
reivilibre Mar 14, 2023
b19b82a
Linting
reivilibre Mar 14, 2023
7bcaa4e
Make the dev-docs group optional
reivilibre Mar 14, 2023
f60a001
Use the dev-docs group
reivilibre Mar 14, 2023
736911e
Let make.bat have CRLF terminator
reivilibre Mar 14, 2023
f39941c
Don't let dev-docs get in the way of old-deps runs
reivilibre Mar 14, 2023
596bc7b
Fix up build in workflow
reivilibre Mar 14, 2023
a2f5558
Update dev-docs/conf.py
reivilibre Mar 24, 2023
2e4ba85
Remove make.bat as suggested
reivilibre Mar 24, 2023
77bcbbb
Merge the two docs workflows together
reivilibre Mar 24, 2023
cf55d47
Update synapse/federation/sender/__init__.py
reivilibre Mar 24, 2023
59ab3c8
Update synapse/federation/sender/__init__.py
reivilibre Mar 24, 2023
a992247
Address some points in the write-up about Federation Senders
reivilibre Mar 24, 2023
ab7b824
Merge branch 'develop' into rei/sphinx_devdocs
reivilibre Mar 24, 2023
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
Prev Previous commit
Next Next commit
Enable autodoc extension in Sphinx
  • Loading branch information
@reivilibre
reivilibre committed Mar 13, 2023
commit 1b23a6a872ee0868c2fea143a0bb04f1bc5032ab
4 changes: 3 additions & 1 deletion dev-docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []
extensions = [
'sphinx.ext.autodoc',
]

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand Down