Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
ビルド方法と Read the Docs の説明を記述
  • Loading branch information
T. H committed Sep 18, 2017
1 parent 64a21cc commit d4b68c3
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Foursquare API 非公式日本語ドキュメント

[![Documentation Status](https://readthedocs.org/projects/docs-foursquare-api-ja/badge/?version=latest)](http://docs-foursquare-api-ja.readthedocs.io/ja/latest/?badge=latest)

## ローカルでのビルド

以下のコマンドを実行して、Sphinx と依存テーマのインストールを行います:

```bash
$ pip install -r requirements.txt
```

プロジェクトのルートで以下のコマンドを実行することで、ルートの `_build` ディレクトリに HTML が生成されます。

```bash
$ sphinx-build -b html . _build
```

## Read the Docs

ドキュメントは以下の Read the Docs に反映されます:
http://docs-foursquare-api-ja.readthedocs.io/ja/latest/

master ブランチが更新されると自動でビルドが走ります。

0 comments on commit d4b68c3

Please sign in to comment.