development.rst

Doma の開発

目次

Note

このページは Doma の開発者に向けて書かれています。

ソースコード

$ git clone git@github.com:domaframework/doma.git

ビルド

$ ./gradlew build

Maven ローカルリポジトリへのインストール

$ ./gradlew build install

Note

ローカルで修正を加えたコードに対して integration-test を実行するには、 ローカルの Maven リポジトリに Doma 本体の成果物を事前にインストールしておく必要があります。

Eclipse

Eclipse の設定ファイルを生成できます。

$ ./gradlew eclipse

Continuous Integration

Continuous Integration の実行には Travis CI を利用しています。

https://travis-ci.org/domaframework/doma

ドキュメント

ドキュメントの作成には Sphinx を利用しています。

環境構築

$ cd docs
$ pip install -r requirements.txt

ドキュメントの生成

$ make dirhtml

LiveReload

Google Chrome に LiveReload をインストールすることで ドキュメントの修正を即座にブラウザで確認できます。

この拡張機能を有効にした上でサーバーを起動します。

$ python server.py

次の URL でドキュメントを確認できます。

http://localhost:5500/_build/dirhtml/