Skip to content
This repository has been 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

merged 20 commits into from
Mar 24, 2023

Commits on Mar 13, 2023

  1. Set up a Sphinx site in dev-docs

    @reivilibre
    reivilibre committed Mar 13, 2023
    Configuration menu
    Copy the full SHA
    a517600 View commit details
    Browse the repository at this point in the history

  2. Enable autodoc extension in Sphinx

    @reivilibre
    reivilibre committed Mar 13, 2023
    Configuration menu
    Copy the full SHA
    1b23a6a View commit details
    Browse the repository at this point in the history

  3. Start off an example of how to document a module

    @reivilibre
    reivilibre committed Mar 13, 2023
    Configuration menu
    Copy the full SHA
    8db5e35 View commit details
    Browse the repository at this point in the history

Commits on Mar 14, 2023

  1. Switch to autodoc2 and MyST (Markdown)

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    11cfb3e View commit details
    Browse the repository at this point in the history

  2. Write up documentation about Federation Sending

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    b5b7070 View commit details
    Browse the repository at this point in the history

  3. Add a GH workflow for developer documentation

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    7f96f0d View commit details
    Browse the repository at this point in the history

  4. Newsfile 

    Signed-off-by: Olivier Wilkinson (reivilibre) <[email protected]>
    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    cce451b View commit details
    Browse the repository at this point in the history

  5. Linting

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    b19b82a View commit details
    Browse the repository at this point in the history

  6. Make the dev-docs group optional

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    7bcaa4e View commit details
    Browse the repository at this point in the history

  7. Use the dev-docs group

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    f60a001 View commit details
    Browse the repository at this point in the history

  8. Let make.bat have CRLF terminator

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    736911e View commit details
    Browse the repository at this point in the history

  9. Don't let dev-docs get in the way of old-deps runs

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    f39941c View commit details
    Browse the repository at this point in the history

  10. Fix up build in workflow

    @reivilibre
    reivilibre committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    596bc7b View commit details
    Browse the repository at this point in the history

Commits on Mar 24, 2023

  1. Update dev-docs/conf.py 

    Co-authored-by: Patrick Cloke <[email protected]>
    @reivilibre @clokep
    reivilibre and clokep authored Mar 24, 2023
    Configuration menu
    Copy the full SHA
    a2f5558 View commit details
    Browse the repository at this point in the history

  2. Remove make.bat as suggested 

    Revert "Let make.bat have CRLF terminator"

This reverts commit 736911e.
    @reivilibre
    reivilibre committed Mar 24, 2023
    Configuration menu
    Copy the full SHA
    2e4ba85 View commit details
    Browse the repository at this point in the history

  3. Merge the two docs workflows together

    @reivilibre
    reivilibre committed Mar 24, 2023
    Configuration menu
    Copy the full SHA
    77bcbbb View commit details
    Browse the repository at this point in the history

  4. Update synapse/federation/sender/__init__.py 

    Co-authored-by: Patrick Cloke <[email protected]>
    @reivilibre @clokep
    reivilibre and clokep authored Mar 24, 2023
    Configuration menu
    Copy the full SHA
    cf55d47 View commit details
    Browse the repository at this point in the history

  5. Update synapse/federation/sender/__init__.py 

    Co-authored-by: Patrick Cloke <[email protected]>
    @reivilibre @clokep
    reivilibre and clokep authored Mar 24, 2023
    Configuration menu
    Copy the full SHA
    59ab3c8 View commit details
    Browse the repository at this point in the history

  6. Address some points in the write-up about Federation Senders

    @reivilibre
    reivilibre committed Mar 24, 2023
    Configuration menu
    Copy the full SHA
    a992247 View commit details
    Browse the repository at this point in the history

  7. Merge branch 'develop' into rei/sphinx_devdocs

    @reivilibre
    reivilibre committed Mar 24, 2023
    Configuration menu
    Copy the full SHA
    ab7b824 View commit details
    Browse the repository at this point in the history