Sphinx ドキュメンとのサイドバーに目次を表示する方法

Sphinx で使用するテンプレートによっては、サイドバーに目次が表示されません。
しかし、カスタムテンプレートを作成してすることで目次を表示させることができます。

目次表示用のテンプレートを作成する

目次表示用に使用するテンプレートを作成して「ドキュメントルート/source/_tmeplates」に置いておき、以下の内容で保存します。

<div id="toc" class="sidebarRow">



<h3><a href="{{ pathto(master_doc) }}">目次</a></h3>

{%- if sphinx_version[:3] >= '1.2' %}

{{ toctree (maxdepth=3, collapse=False, includehidden=True) }}

{% else %}

{{ toctree(maxdepth=3, collapse=False) }}

{% endif %}

</div>

conf.pyを編集する

「conf.py」の「html_sidebars」の項目を以下のように記述します。

html_sidebars = {

'**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],

}

• relations.html
• 「Previous topic」「Next topic」を表示する
• sourcelink.html
• 「Show Source」のリンクを表示する
• searchbox.html
• 検索ボックスを表示する

無料のGitホスティングサービス 『Bitbucket』がいい！！

「Simple Midi Player」を作っているときバージョン管理を行っていましたが、一人で作っていたため、人とソースコードやリソースを共有する必要がなかったため、ローカルにリポジトリを作成して行っていました。

ところが、現在作成中のアプリは他の人とソースコードを共有したり、デザインを外注したりする関係で、リモートリポジトリが欲しくなりました。
さらに、公開予定のアプリを管理するリポジトリなので、プライベートリポジトリにしたいと考えていました。

GitHub と Bitbucket

これまで、自分の勉強用で「GitHub」を使用していたのですが、「GitHub」は無料だとプライベートリポジトリが作成することができません。

しかし、もう１つの有名な Gitホスティングサービス「Bitbucket」なら、なんと無料でプライベートリポジトリが作れて、５人までメンバーを招待できるのです！

※念のため書いておきますが、GitHubは素晴らしいサービスです！

Bitbucket

Bitbucket は、Atlassian（アトラシアン）が運営している、Webベースの Gitホスティングサービスです。
やはりBitbucket の最大の特徴は、プライベートリポジトリを「無料で」「いくつでも」作れることではないかと思います。
さらに、無料でも最大で５名までリポジトリにメンバーを追加することができます。
これも、複数人で開発を行う場合に非常に便利な機能です。

ちなみに、Bitbucket は Django フレームワークを使って、Python で書かれているらしい。

登録方法

まず「Bitbucket」のページにアクセスし、以下の画面で「Get Started」をクリックします。



次の画面で、メールアドレスを入力して「Continue」をクリック



あとは、送られてきたメールのリンクから手順通りに登録作業を進めればOK！

プライベートリポジトリの作成

プライベートリポジトリの作成方法を見てみましょう。

1. 画面上部の「リポジトリ」メニューから「リポジトリの作成」を選びます

2. 以下の画面が表示されるので、適当なリポジトリ名を入力し、「これは非公開リポジトリです」にチェックを付けてリポジトリの作成を行うと、プライベートリポジトリとして作成されます。

Advanced Settings をクリックすると、もう少し設定項目が表示されます。

リポジトリの説明文を書いたり、フォークの設定、プロジェクト管理の機能を入れるかどうかなどを設定することができます。

私はいつも課題管理とWikiは有効にしておいて、アプリ内を開発する際にメモなどを残しておくときはWiki に、やらないといけないことなどは課題管理でリスト化したりします。

3. リポジトリを確認

これで、無事にプライベートリポジトリが作成できているはずですが、きとんとプライベートリポジトリになっている場合は、以下の図のように鍵マークが表示されているはずです。

ぜひ皆さんもBitbucket を利用してみてください！

sphinx-quickstartで生成されるMakeifileの内容を変更したい

以下のファイルの「MAKEFILE」の項目を編集することで生成されるMakefileを変更することができます。

~/.pyenv/versions/2.7.7/lib/python2.7/site-packages/sphinx/quickstart.py

※上記のパスは「pyenv」でインストールしたpythonのsphinxを使用している場合なので、自分のPython 環境に合わせて読み替えてください。

なお、どうしても "quickstart.py" が見つけられない場合は、以下のコマンドを自分のHomeディレクトリで以下のコマンドを実行してみてください。

$ find . -name "quickstart.py"