ドキュメントのメンテナンス

Spec-Craft のドキュメントは、多言語管理のために gettext ワークフローを採用しています。

英語ソースの更新

  1. docs/source/ 内の .md ファイルを修正します。

  2. cd docs && make html を実行して、ローカルで確認します。

翻訳(日本語)の更新

英語ソースを変更した後、メッセージカタログを更新する必要があります:

  1. 新しい文字列の抽出:

    cd docs
    make gettext
    
  2. PO ファイルの更新:

    sphinx-intl update -p _build/gettext -l ja
    
  3. docs/source/locale/ja/LC_MESSAGES/ 内の文字列を翻訳します。

  4. 日本語版のビルド:

    make ja
    

Read the Docs

main ブランチに push すると、Read the Docs 上で自動的にビルドがトリガーされます。.readthedocs.yamldocs/requirements.txt が最新であることを確認してください。