Sphinxのドキュメントを追加 #78
Merged
Sphinxのドキュメントを追加 #78
Conversation
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
|
プロジェクトの情報は # -- Project information -----------------------------------------------------
project = 'pybotters'
copyright = '2021, MtkN1XBt'
author = 'MtkN1XBt' |
|
テーマはよく使われているRead The Docsを利用しています テーマを変更する場合には html_theme = 'sphinx_rtd_theme' |
|
ローカル環境でHTMLをビルドする場合には下記のコマンドを実行します cd docs
pip install -r requirements.txt
make htmlビルドが完了すると、 |
MtkN1
approved these changes
Aug 7, 2021
|
確認しました。分かりやすい手順までありがとうございます！ |
Merged
MtkN1
added a commit
that referenced
this pull request
Aug 15, 2021
✨v0.6.0リリース ## Issues ✅ 対応取引所の追加(Phemex、Coincheck) #52 ✅ GMO コインの DataStore を実装する #60 ✅ リリース表記をPreview版にする #73 ✅ FTXDataStore の orders チャネルにおける close されたオーダーの取り扱いについて #75 ✅ DataStoreInterfaceのクラス名を変更する #79 ## Pull requests ✅ GMO コイン用の DataStore を一部実装する #74 ✅ DataStore のレコード削除メソッドのサンプル実装 #76 ✅ DataStore の wait メソッドが変更されたデータを返す実装 #77 ✅ Sphinxのドキュメントを追加 #78
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
以下、Read The Docs側の手順です
Read The Docsにアクセスします
これから登録する場合はGitHubアカウントがおすすめです
https://readthedocs.org
「プロジェクトを取り込む」をクリックします
「リポジトリをimport」画面で、対象のリポジトリ(
MtkN1/pybotters)の右に表示されている「+」をクリックしますmainブランチにマージされている場合は「次へ」をクリックします、ブランチを変更する場合には「デフォルトブランチ」にブランチ名を入力します
自動的にビルドが開始します、「ビルド」をクリックするとビルド状況が確認できます
ビルドが成功していたら、「開く」をクリックすると、デプロイされたドキュメントが表示されます