Skip to content

Home

Jump to bottom
Kazuhiro KOBAYASHI edited this page Sep 5, 2017 · 10 revisions

ToDo

Before release

  • docmentの整備
    • documentのコンパイル
    • documentのチェックと修正
    • Main documentの執筆
    • documentのホスティングへのupload
  • Example scripts or integrated test scriptsの追加（差分VC)

After release

  • VC scriptsを上げたレポジトリを作成
    • 色々なVC（e.g., EVC，DNN-VC）を実現するコードをsprocketで作成し公開する

How to build sphinx documents

sphinx-apidoc -F -o docs sprocket
cd docs
make html
  • 現状のクラス等に関してはこれでbuild出来るが，sprocket全体の説明等を記述するためには，また別の方法が必要となるはず．

How to merge after creating Pull Request

We assume 'PRbranch' is a branch which was already lined up at the pull request and reviewed.

git checkout PRbranch
git rebase -i HEAD~N  # Integrate N commit into one or several commit 
git fetch origin # featch origin/master into local
git rebase origin/master # solve conflict between PRbranch and origin/master
git push -f origin PRbranch # forced to merge origin/PRbranch

Finally, the PRbranch is merged into origin/master using a button of Merge in pull request page.

How to accept both Python2 and Python3 in Python scripts

  • Recite from future import division, print_function, absolute_import in preamble
  • Describe division as ```//`` for type int.
  • ".pkl" file depends on Python version.
Clone this wiki locally