From fc7cd92ee23a87b2506db5f63f25e5f41b0e0435 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sat, 26 Aug 2023 13:36:10 +0200 Subject: [PATCH 1/3] docs: tox -e docs tests building the docs --- tox.ini | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index c32fd5711..a4a8b1d75 100644 --- a/tox.ini +++ b/tox.ini @@ -2,13 +2,14 @@ # fakeroot -u tox --recreate [tox] -envlist = py{39,310,311}-{none,fuse2,fuse3} +envlist = py{39,310,311}-{none,fuse2,fuse3},docs minversion = 3.2 requires = pkgconfig cython wheel setuptools_scm + [testenv] package = editable-legacy # without this it does not find setup_docs when running under fakeroot setenv = @@ -42,3 +43,11 @@ deps = mypy pkgconfig commands = mypy + +[testenv:docs] +changedir = docs +deps = + sphinx + guzzle_sphinx_theme +commands = + sphinx-build -n -v -W --keep-going -b html -d {envtmpdir}/doctrees . {envtmpdir}/html From d2d6e6092b346482b4a0559bd47316f14559965b Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sat, 26 Aug 2023 13:44:08 +0200 Subject: [PATCH 2/3] CI: test building the docs --- .github/workflows/ci.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b0ad228ad..70b28b449 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -55,6 +55,9 @@ jobs: - os: ubuntu-20.04 python-version: '3.9' toxenv: mypy + - os: ubuntu-20.04 + python-version: '3.11' + toxenv: docs - os: ubuntu-20.04 python-version: '3.9' toxenv: py39-fuse2 From 04ff8d6524667b4bf554a0a35200f465e860fae3 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sat, 26 Aug 2023 13:55:59 +0200 Subject: [PATCH 3/3] fix README --- README.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.rst b/README.rst index c814b58d4..d7c391d31 100644 --- a/README.rst +++ b/README.rst @@ -13,8 +13,6 @@ TODO: the screencasts need a remake using borg2, see there: https://github.com/borgbackup/borg/issues/6303 -.. |screencast_basic| -.. More screencasts: `installation`_, `advanced usage`_ What is BorgBackup? -------------------