reStructuredText ドキュメントの検査・修正 CLI ツール

Important Notes 注意事項

This utility is intended for Japanese text and does not work with other languages.

このユーティリティは日本語向けであり、他の言語では使えない

機能紹介

  • インライン記法の前後スペースを検査・修正する

  • 強調表示（ **...** ）の前後スペースを検査・修正する

  • セクションタイトルの下線幅を検査・修正する

  • 句点と改行のスタイルを検査・修正する（注意: 末尾の句点を削除する特殊なスタイルである）

インストール

Python 3.14 以上が必要である。 PyPI からパッケージを入れると、依存の docutils 0.22 系も同時に入る

uv で CLI としてインストールする

uv tool install wabun-rst-ulint

pip でインストールする

pip install wabun-rst-ulint

インストール後は wabun-rst-ulint コマンドが使える。 次で確認する

wabun-rst-ulint --help

使い方

呼び出しは次のとおりである

wabun-rst-ulint <subcommand> [--check|--fix] <paths...>

paths にはファイルまたはディレクトリを指定する。 ディレクトリを指定した場合は .rst ファイルを再帰的に検索する

--check と --fix は相互排他である。 --check は違反の検出のみを行い、違反があれば終了コード 1 で終了する。 --fix は検出された違反を自動修正する。 どちらも指定しない場合は --check と同じ動作になる

サブコマンド

サブコマンド

検査対象

inline-spacing

インライン記法の外部境界スペース

strong-spacing

強調表示前後の半角スペース

heading-width

セクションタイトル装飾行の表示幅

sentence-breaks

句点と改行のスタイルルール

inline-spacing

インライン記法（インラインリテラル、role 参照、名前付き参照、匿名参照、内部ターゲット、interpreted text）の外部境界にある半角スペースの過不足を検出・修正する。 日本語に直接隣接すると docutils が markup を認識できない。 認識できる場合でも、句読点の直前、中黒の前後、隣接する role の間には半角スペースを補う

値は``foo``です          →  値は ``foo`` です
これは :term:`X`。       →  これは :term:`X` 。
中黒・:term:`X`・区切り  →  中黒・ :term:`X` ・区切り
:ref:`a`:ref:`b` です    →  :ref:`a` :ref:`b` です

wabun-rst-ulint inline-spacing docs/
wabun-rst-ulint inline-spacing --fix docs/

strong-spacing

強調表示 **...** の前後に半角スペースがない箇所を検出・修正する。 単一アスタリスクの emphasis （ *...* ）は対象外である

wabun-rst-ulint strong-spacing --fix source/

heading-width

セクションタイトルの下線・上下線の表示幅がタイトルと一致しない場合を検出・修正する。 日本語全角文字は表示幅 2 として計算する

追加オプションは次のとおりである

  • --diff : 修正案を unified diff として標準エラー出力に出す。 ファイルは書き換えない。 --check / --fix と相互排他

  • --backup-suffix SUFFIX : --fix の前にバックアップを作る。 --fix との併用が必須

  • --follow-symlinks : シンボリックリンクを検査対象に含める。 --fix とは併用できない

    wabun-rst-ulint heading-width --diff docs/
wabun-rst-ulint heading-width --fix --backup-suffix .bak docs/

sentence-breaks

本文中の句点の後ろで改行されていない箇所と、テキストブロック末尾の不要な句点を検出・修正する。 --follow-symlinks を持つ

wabun-rst-ulint sentence-breaks --fix docs/

ディレクトリの再帰検索

heading-width と sentence-breaks は .git 、 .venv 、 __pycache__ 、 node_modules 、 _build などを除外する。 シンボリックリンクは --follow-symlinks を付けたときだけ対象に含める

inline-spacing と strong-spacing はディレクトリを除外しない。 これらの --fix では . ではなく対象ディレクトリを明示する

終了コード

コード

意味

0

違反なし、または --fix による修正が成功

1

違反を検出、対象ファイルが見つからない、読み取り/書き込みエラー

2

引数エラー。 sentence-breaks の I/O エラーも 2

Project links

Data verified by PyPI on Aug 30, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for usaturn from gravatar.com usaturn

Credits

Author: usaturn

GitHub Statistics

Data verified by PyPI on Aug 30, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.14

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wabun_rst_ulint-0.0.1.tar.gz (46.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wabun_rst_ulint-0.0.1-py3-none-any.whl (55.9 kB view details)

Uploaded Python 3

File details

Details for the file wabun_rst_ulint-0.0.1.tar.gz.

File metadata

  • Download URL: wabun_rst_ulint-0.0.1.tar.gz
  • Upload date:
  • Size: 46.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for wabun_rst_ulint-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c4df9fe3679288993f040a5558b99d9bd59a0b1754096293145e2e15ffc74b6d
MD5 7e0fdb6acf6158a5631aea7c6cf75381
BLAKE2b-256 45e6103f3aaded6ccac9e7e91ea04fafe9f620a92f52bccd9162b6fc8ab65faa

See more details on using hashes here.

Provenance

The following attestation bundles were made for wabun_rst_ulint-0.0.1.tar.gz:

Publisher: publish-to-pypi.yml on usaturn/wabun-rst-ulint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wabun_rst_ulint-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: wabun_rst_ulint-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 55.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for wabun_rst_ulint-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a0b45b8ca24d6ac8391fbd18fe6b21dcab7f97d2d0f910c597f4de65d7a9d20
MD5 2f37e5edca6018aeeef0559ddb8f647f
BLAKE2b-256 084e529e2236a7780204feafe6f33ccec3bc219914ee9ffc6bcc204d27c492fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for wabun_rst_ulint-0.0.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on usaturn/wabun-rst-ulint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page