Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sphinx documentation #92

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Sphinx documentation #92

wants to merge 2 commits into from

Conversation

k2kobayashi
Copy link
Owner

@k2kobayashi k2kobayashi commented Sep 29, 2017 •
edited

Done

  • sphinx-quickstartでのdocument作成の準備
  • sphinx-apidocによるsprocket関数の自動ドキュメント化

ToDo

  • sprocket.speech.feature_extractor.FeatureExtractorではなく，sprocket.speech.FeatureExtractorとドキュメントが表示される様にしたい．
  • speech, model, utilの3つの大枠がある事を示すページがほしい
  • Markdownでの動作の確認
  • GitHub.io へのドキュメントの公開
  • masterにmerge時のドキュメントの自動コンパイルとアップロード

@k2kobayashi
Copy link
Owner Author

#27

@tats-u
Copy link
Collaborator

tats-u commented Oct 2, 2017

Makefileは自動で生成したものですか？EOFの改行がないのが気になりますが。

@k2kobayashi
Copy link
Owner Author

makefileはsphinxによる自動生成です．

tats-u
tats-u reviewed Oct 2, 2017
View reviewed changes
Copy link
Collaborator

@tats-u tats-u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

現状のところ問題はありません

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tats-u tats-u tats-u left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@k2kobayashi @tats-u