Skip to content

Commit

Permalink
Merge pull request #254 from ma10/update-contributing-20240723
Browse files Browse the repository at this point in the history
contributing.rst: yaml2rst.pyのパス変更を反映
  • Loading branch information
ma10 authored Jul 23, 2024
2 parents 390adf8 + 04c5a90 commit 3f06b79
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 12 deletions.
17 changes: 11 additions & 6 deletions en/source/intro/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,17 +83,23 @@ The repository's root directory contains the following directories:
:file:`json`
Contains schema definitions for files in the :file:`yaml` directory and files needed to process these files.
:file:`tools`
:file:`yaml2rst`
Contains scripts and related files needed to generate the required reST files.
Originally, it was a script for processing YAML files and outputting reST files, thus the name, but now it also includes the functionality to process the source code of axe-core and output the necessary reST file.
:file:`yaml2x`
:file:`yaml2rst`
Contains scripts and related files needed to generate the required reST files.
Originally, it was a script for processing YAML files and outputting reST files, thus the name, but now it also includes the functionality to process the source code of axe-core and output the necessary reST file.
:file:`yaml2json`
Contains a script to process a group of YAML files and convert them into a JSON file.
Note that this script is not necessary for generating HTML files.
:file:`a11y_guidelines`
Contains modules commonly used by both ``yaml2rst`` and ``yaml2json``.
:file:`vendor`
Contains the source code of repositories referenced as submodules.
Currently, this includes the source code of axe-core.
Executing ``yaml2rst``
======================
Executing the ``tools/yaml2rst/yaml2rst.py`` script allows you to generate the necessary reST files.
Executing the ``tools/yaml2x/yaml2rst/yaml2rst.py`` script allows you to generate the necessary reST files.
There are several command-line options, but the following two are necessary for manual execution:
``--lang`` or ``-l`` option
Expand All @@ -105,7 +111,7 @@ For example, executing the following in the repository's root directory outputs
.. code:: shell
python tools/yaml2rst/yaml2rst.py -l ja -b .
python tools/yaml2x/yaml2rst/yaml2rst.py -l ja -b .
Note that executing ``make html`` in the root directory also includes the execution of this script, along with the necessary processes to output HTML for both the Japanese and English versions.
Expand All @@ -129,7 +135,6 @@ About the English Version
=========================
The normative version of this document is in Japanese.
Currently, there are untranslated pages, and for these, the source of the Japanese version is included as it is.
The English version is a translation of the content of the Japanese version, but where there are differences, the content of the Japanese version takes precedence.
We try to update the English version simultaneously with the Japanese version, but there are cases where the update of the Japanese version precedes.
Expand Down
17 changes: 11 additions & 6 deletions ja/source/intro/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,23 @@ HTMLファイルの生成のために必要な情報はMakefileに記述され
:file:`json`
:file:`yaml` ディレクトリー内のファイルのスキーマ定義と、これらのファイルを処理するために必要なファイルが含まれています。
:file:`tools`
:file:`yaml2rst`
必要なreSTファイルを生成するためのスクリプトと関連ファイルが含まれています。
元々はYAMLファイルを処理してreSTファイルを出力するためのスクリプトだったのでこのような名前になっていますが、現在はaxe-coreのソース・コードを処理して必要なreSTファイルを出力する機能も追加されています。
:file:`yaml2x`
:file:`yaml2rst`
必要なreSTファイルを生成するためのスクリプトと関連ファイルが含まれています。
元々はYAMLファイルを処理してreSTファイルを出力するためのスクリプトだったのでこのような名前になっていますが、現在はaxe-coreのソース・コードを処理して必要なreSTファイルを出力する機能も追加されています。
:file:`yaml2json`
YAMLファイル群れを処理してJSONファイルに変換するためのスクリプトが含まれています。
なおこのスクリプトは、HTMLファイルの生成に当たっては必要ありません。
:file:`a11y_guidelines`
``yaml2rst`` と ``yaml2json`` で共通に使用するモジュールが含まれています。
:file:`vendor`
サブモジュールとして参照しているリポジトリーのソース・コードが含まれています。
現時点では、axe-coreのソース・コードが含まれています。

``yaml2rst`` の実行
===================

``tools/yaml2rst/yaml2rst.py`` スクリプトを実行すると、必要なreSTファイルを生成することができます。
``tools/yaml2x/yaml2rst/yaml2rst.py`` スクリプトを実行すると、必要なreSTファイルを生成することができます。
いくつかのコマンド・ライン・オプションがありますが、手動で実行する場合は以下の2つのオプションが必要です。

``--lang`` または ``-l`` オプション
Expand All @@ -107,7 +113,7 @@ HTMLファイルの生成のために必要な情報はMakefileに記述され

.. code:: shell
python tools/yaml2rst/yaml2rst.py -l ja -b .
python tools/yaml2x/yaml2rst/yaml2rst.py -l ja -b .
なお、ルート・ディレクトリーで ``make html`` を実行すると、このスクリプトの実行も含めて、日本語版、英語版のHTMLを出力するために必要な処理が実行されます。

Expand All @@ -131,7 +137,6 @@ HTMLファイルの生成のために必要な情報はMakefileに記述され
================

この文書の正式版は日本語版です。
現時点で、未訳のページもあり、これらについては日本語版のソースがそのまま含まれている状態になっています。
英語版は、日本語版の内容を翻訳したものですが、日本語版の内容と異なる部分がある場合は、日本語版の内容が優先されます。

日本語版の更新に当たっては、なるべく同時に英語版を更新するようにしていますが、日本語版の更新が先行する場合もあります。
Expand Down

0 comments on commit 3f06b79

Please sign in to comment.