From 80b9b7719a5ce5317fcdb955c965f629624853bc Mon Sep 17 00:00:00 2001 From: Takayuki SHIMIZUKAWA Date: Wed, 6 Nov 2024 06:13:28 +0000 Subject: [PATCH 1/2] fix for lint --- AUTHORS.rst | 4 ++-- doc/basic.rst | 4 ++-- doc/dev.rst | 2 +- doc/quickstart.rst | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index c87b1eb..6ad2a0e 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -10,5 +10,5 @@ Original This utility derived from these projects. -* https://bitbucket.org/tk0miya/sphinx-gettext-helper -* https://bitbucket.org/shimizukawa/sphinx-transifex +* ``https://bitbucket.org/tk0miya/sphinx-gettext-helper`` +* ``https://bitbucket.org/shimizukawa/sphinx-transifex`` diff --git a/doc/basic.rst b/doc/basic.rst index dd3cfda..e896e38 100644 --- a/doc/basic.rst +++ b/doc/basic.rst @@ -27,7 +27,7 @@ You need to use `tx` command for below features: * ``tx push -s`` : push pot (translation catalogs) to transifex. * ``tx pull -l ja`` : pull po (translated catalogs) from transifex. -.. _transifex-client: https://github.com/transifex/cli +.. _Transifex Client: https://github.com/transifex/cli Installation @@ -38,5 +38,5 @@ It is strongly recommended to use virtualenv/venv for this procedure:: $ pip install sphinx-intl If you want to use `Optional Features`_, you need install Transifex CLI tool. -Please refer to `Installation instructions `_. +Please refer to `Installation instructions `_. diff --git a/doc/dev.rst b/doc/dev.rst index e4cd51b..cf94e24 100644 --- a/doc/dev.rst +++ b/doc/dev.rst @@ -21,7 +21,7 @@ Setup development environment $ pip install -U pip setuptools wheel setuptools_scm $ pip install -r requirements-dev.txt -* Install Transifex CLI tool (refer to `Installation instructions `_):: +* Install Transifex CLI tool (refer to `Installation instructions `_):: $ curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash diff --git a/doc/quickstart.rst b/doc/quickstart.rst index f17cf17..a52c3cd 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -29,7 +29,7 @@ This section describe how to translate with Sphinx_ and `sphinx-intl` command. `locale_dirs` is required and `gettext_compact` is optional. - refs `example `__. + refs `example `__. 3. Extract document's translatable messages into pot files:: From ca7fa186a7afdd50cfc5f7915b31ffa7f981684c Mon Sep 17 00:00:00 2001 From: Takayuki SHIMIZUKAWA Date: Wed, 6 Nov 2024 07:31:25 +0000 Subject: [PATCH 2/2] add asterisk for paths to catch all changes under doc/ --- .github/workflows/doc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 99f87fa..2277bf7 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -2,11 +2,11 @@ name: Docs on: push: paths: - - 'doc/' + - 'doc/**' - '.github/workflows/doc.yml' pull_request: paths: - - 'doc/' + - 'doc/**' - '.github/workflows/doc.yml' workflow_dispatch: