From cf5dce91d3b287c6bcab28d45871e5fc09ddc3ad Mon Sep 17 00:00:00 2001 From: Jan Grodowski Date: Fri, 6 Dec 2024 11:18:58 +0100 Subject: [PATCH] Fix docs build & warnings, update sphinx deps and create a venv to avoid clashes --- .github/workflows/build-docs.sh | 6 +++++- docs/source/conf.py | 4 ++-- docs/source/verifiers.rst | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build-docs.sh b/.github/workflows/build-docs.sh index 3bc21748b..c526227af 100755 --- a/.github/workflows/build-docs.sh +++ b/.github/workflows/build-docs.sh @@ -4,7 +4,11 @@ set -xe sudo apt-get update sudo apt-get install -y python3-pip -sudo pip3 install sphinx==1.8.5 + +python3 -m venv ./venv +source venv/bin/activate + +pip3 install sphinx==8.1.3 cd docs make html diff --git a/docs/source/conf.py b/docs/source/conf.py index 5017373f5..b8a415aac 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -46,7 +46,7 @@ # General information about the project. project = u'Ghostferry' -copyright = u'2017, Shopify' +copyright = u'2017-2024, Shopify' author = u'Shopify' # The version info for the project you're documenting, acts as replacement for @@ -63,7 +63,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/source/verifiers.rst b/docs/source/verifiers.rst index 1e1454fbf..8957e6921 100644 --- a/docs/source/verifiers.rst +++ b/docs/source/verifiers.rst @@ -96,7 +96,7 @@ cases are possible. algorithm to enumerate the table and tail the binlogs. IterativeVerifier (Deprecated) ------------------ +------------------------------ **NOTE! This is a deprecated verifier. Use the InlineVerifier instead.**