-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 ブランチが更新されると自動でビルドが走ります。 |