SphinxのプロジェクトをGithubへプッシュする

この節ではグラフィカルに操作できるSourceTreeを使ってSphinxのプロジェクトをGitリポジトリにして(=プロジェクトをGitの管理下におく)リポジトリのホスティングサービスGithubにプッシュ(アップロード)するところまでを説明します。

Githubのアカウントを作成する

下記サイトにアクセスしSign upより、UsernameEmail AddressPasswordを入力し、アカウントを作成します。

https://github.com/

SourceTreeのインストール

SourceTreeはWindows版と Mac OS X版が用意されています。いずれの場合も以下のサイトからダウンロードしインストールして下さい。

https://www.sourcetreeapp.com/

インストール中にGithubのアカウントを求められるので作成したアカウントを入力して下さい。

Sphinxのプロジェクトをリポジトリにする

テスト用のプロジェクトを作成しGitのリポジトリにします。例ではtestprojectというディレクトリを作成しsphinx-quickstartmake htmlを実行した所から始めます。

make htmlを打った直後のディレクトリ/ファイル構成は図のようになっています。

├─testproject
    │  conf.py
    │  index.rst
    │  make.bat
    │  Makefile
    │
    ├─_build ■1. makeコマンドを打つ度に生成し直される為、Git(SourceTree)で管理しないよう設定する
    │  ├─doctrees
    │  │      environment.pickle
    │  │      index.doctree
    │  │
    │  └─html
    │      │  .buildinfo
    │      │  genindex.html
    │      │  index.html
    │      │  objects.inv
    │      │  search.html
    │      │  searchindex.js
    │      │
    │      ├─_sources
    │      │      index.txt
    │      │
    │      └─_static
    │              ajax-loader.gif
    │              .
    │              .
    │              .
    │              websupport.js
    │
    ├─_static ■2. Gitは空のディレクトリを管理できず、このディレクトリが存在しないとmakeするたびWARNINGが表示される為、ダミーファイルを置く必要がある
    └─_templates ■3. 空ディレクトリで管理する必要は無い

_staticディレクトリにcustom.css(任意の名前の空ファイル)を保存します(■2の対応)。

SourceTreeを起動し新規/クローンを作成するをクリックします。

../../_images/git_01.png

リポジトリをクローン/追加/作成というウィンドウが表示されるのでリポジトリを作成をクリックします。リポジトリタイプGit保存先のパスにテスト用のプロジェクトのパスを入力し作成ボタンをクリックします。

../../_images/git_02_02.png

作業ツリーのファイルの表示で_build/が表示されている行を右クリックし無視をクリックします。

../../_images/git_03.png

無視というウィンドウが表示されるので以下にある物全てを無視にチェックを入れ_buildが選択されている事を確認しOKをクリック(■1の対応)

作業ツリーのファイルにチェックを入れます。

../../_images/git_04_02.png

自動的にIndexにステージしたファイルの配下に全てのファイルが移動します。

../../_images/git_05.png

一番下の薄くコミットメッセージと表示されている部分をクリックします。

../../_images/git_06.png

表示領域が広がるので、コミットメッセージとしてinitialと入力しコミットボタンをクリックします。

../../_images/git_08.png

ログタブをクリックします。コミットが成功していると図のように表示されます。

../../_images/git_09.png

作成したリポジトリをGithubにプッシュする

Githubにプッシュする為には先にGithubで空のリポジトリを作成する必要があります。GithubにログインしNew repositoryをクリックします。

../../_images/git_10_02.png

Repository nameにリポジトリを表す簡潔な名前を入力します。元のリポジトリのディレクトリ名でなくても構いません。例ではディレクトリ名と同じtestprojectと入力しています。Descriptionにも簡単な説明を入力します。例ではTESTにしています。入力が終わったらCreate repositoryをクリックします。

../../_images/git_11_02.png

これでGithub上に空のリポジトリができました。プッシュする為にHTTPSをクリックしURLをクリップボードにコピーして下さい。

../../_images/git_12_02.png

SourceTreeに戻りリポジトリリモートを追加をクリックします。

../../_images/git_13.png

リモートの詳細設定ウィンドウが表示されるのでデフォルトリモートにチェックを入れ、コピーしたURLをURL/パスに貼り付け、OKをクリックします。

../../_images/git_14_02.png

リポジトリ設定ウィンドウが表示されるのでリモートリポジトリのパスが表示されている事を確認してOKをクリックします。

../../_images/git_15_02.png

プッシュをクリックします。

../../_images/git_16.png

プッシュウィンドウが表示されるのでmasterにチェックを入れてOKをクリックします。

../../_images/git_17_02.png

Authenticateダイアログが表示されるのでUsernamePasswordGithubアカウントを入力しLoginをクリックします。

../../_images/git_18.png

Githubに戻り図のようにリポジトリの中身が表示されたらプッシュに成功しています。

../../_images/git_19_02.png