開発者ガイド#
GWexpy 本体やドキュメントを変更する場合は、このページから始めてください。解析の手順を探す場合は、はじめにを参照してください。
作業 |
参照先 |
|---|---|
作業用チェックアウトの準備と変更の提出 |
|
コンテナと処理層の理解 |
|
数値計算とメタデータの挙動の確認 |
|
検証の実行 |
|
内部仕様と設計判断の確認 |
公開ドキュメントのビルド#
ドキュメント用の依存パッケージを導入した、プロジェクトの gwexpy Conda 環境を使います。ソースのチェックアウトから、リポジトリ外の新しい一時ディレクトリを準備してください。
python scripts/prepare_public_docs.py /tmp/gwexpy-docs-preview/docs_redesign
python -m sphinx -b html /tmp/gwexpy-docs-preview/docs_redesign /tmp/gwexpy-docs-preview/html
python -m sphinx -b html -D language=ja /tmp/gwexpy-docs-preview/docs_redesign /tmp/gwexpy-docs-preview/html/ja
python scripts/check_public_docs.py /tmp/gwexpy-docs-preview/html
再実行する場合は、新しい出力ディレクトリを指定してください。準備処理は正本のノートブックからコードを読み取り、実行結果をチェックアウトの外に保存します。公開ページの英語本文と日本語 gettext カタログは併せて管理します。ノートブックの実行セルを変更する場合は、正本を編集してから準備処理を実行してください。公開用ノートブックは説明文と翻訳対象の識別情報を保持します。
Studio#
GWexpy Studio は開発中の別インターフェースです。これらのチュートリアルを完了するために必要なものではありません。配布方法と基本的な操作手順を再現できる段階で、Studio 用の学習コースを追加します。それまでは、ダウンロード可能な Python の例を学習教材の入口として提供します。