Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs build & warnings, update sphinx deps and create a venv to avoid clashes #374

Merged
merged 1 commit into from
Dec 6, 2024
Merged

Fix docs build & warnings, update sphinx deps and create a venv to avoid clashes #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion .github/workflows/build-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/verifiers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

Expand Down
Loading