Skip to content

Commit

Permalink
Drop sphinx docs (#17073)
Browse files Browse the repository at this point in the history
It is broken, and we only seemed to have been building it for the
federation sender.

Closes #16804
  • Loading branch information
erikjohnston authored May 1, 2024
1 parent 7254015 commit 0b358f8
Show file tree
Hide file tree
Showing 7 changed files with 1 addition and 138 deletions.
30 changes: 0 additions & 30 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,33 +85,3 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book
destination_dir: ./${{ needs.pre.outputs.branch-version }}

################################################################################
pages-devdocs:
name: GitHub Pages (developer docs)
runs-on: ubuntu-latest
needs:
- pre
steps:
- uses: actions/checkout@v4

- name: "Set up Sphinx"
uses: matrix-org/setup-python-poetry@v1
with:
python-version: "3.x"
poetry-version: "1.3.2"
groups: "dev-docs"
extras: ""

- name: Build the documentation
run: |
cd dev-docs
poetry run make html
# Deploy to the target directory.
- name: Deploy to gh pages
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./dev-docs/_build/html
destination_dir: ./dev-docs/${{ needs.pre.outputs.branch-version }}
1 change: 1 addition & 0 deletions changelog.d/17073.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove broken sphinx docs.
20 changes: 0 additions & 20 deletions dev-docs/Makefile

This file was deleted.

50 changes: 0 additions & 50 deletions dev-docs/conf.py

This file was deleted.

22 changes: 0 additions & 22 deletions dev-docs/index.rst

This file was deleted.

5 changes: 0 additions & 5 deletions dev-docs/modules/federation_sender.md

This file was deleted.

11 changes: 0 additions & 11 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -364,17 +364,6 @@ towncrier = ">=18.6.0rc1"
tomli = ">=1.2.3"


# Dependencies for building the development documentation
[tool.poetry.group.dev-docs]
optional = true

[tool.poetry.group.dev-docs.dependencies]
sphinx = {version = "^6.1", python = "^3.8"}
sphinx-autodoc2 = {version = ">=0.4.2,<0.6.0", python = "^3.8"}
myst-parser = {version = "^1.0.0", python = "^3.8"}
furo = ">=2022.12.7,<2025.0.0"


[build-system]
# The upper bounds here are defensive, intended to prevent situations like
# https://github.com/matrix-org/synapse/issues/13849 and
Expand Down

0 comments on commit 0b358f8

Please sign in to comment.