Python: docstring を書いてみよう - CUBE SUGAR CONTAINER
Python の docstring というのは、モジュールやクラス、関数などにつける説明文のこと。 単純なコメントとの違いは、より仕様に近い内容を記述しておくことで API のドキュメントとして利用できる他、別のドキュメントから内容を読み込んで使ったりすることができる。 今回は docstring の書かれたサンプルコードを元に、REPL からその内容を参照したり、ドキュメンテーションツール Sphinx でその内容を読み込むというのを試してみる。 docstring の書かれたソースコードを用意する 以下が docstring の書かれた Python のソースコード。 内容については FizzBuzz 問題を題材にしている。 モジュールや関数の先頭で “”“ や ‘’‘ を使ってコメントを書いておくと、それが自動的に docstring として扱われることになる。 #!/usr/bi
Sphinx: 既存のテーマをカスタマイズする - CUBE SUGAR CONTAINER
Sphinx はドキュメントのコンテンツとデザインが分離されている。 デザインを変えたいときはテーマを変更すれば良い。 ただ、既存のテーマそのままでは満足できる見栄えにならないときもある。 そんなときは既存のテーマをカスタマイズする必要が出てくる。 今回はそのやり方について書く。 環境には Mac OS X を使っている。 $ sw_vers ProductName: Mac OS X ProductVersion: 10.11.2 BuildVersion: 15C50 下準備 まずは下準備として Sphinx をインストールする。 $ pip install sphinx 次に sphinx-quickstart コマンドを使ってドキュメントを用意する。 デフォルトの入力値から変更しているところだけ示す。 $ sphinx-quickstart > Separate source an
Sphinxのテーマを継承して体裁をカスタマイズしよう
斎藤です。こんにちは。 今日は、SphinxでHTMLのドキュメントを生成する際、ドキュメント全体に対して体裁の変更を行えるよう、テーマを継承する方法をお話しします。本記事では、「継承する理由」「組み方」そして「注意点」の3点についてまとめました。 ※検証したソフトウェアのバージョンば、Sphinxは1.1.3sphinxjp-latex、Pythonは2.6.6 (CentOS 6.4標準rpm)です。 継承する理由 Sphinxとは、Pythonで動作し、reStructuredText(以下、reST)で記述するドキュメント生成エンジンです。出力は、HTMLばかりでなく、LaTeX(PDF)やmanなど多様な形式をサポートしています。また、HTML出力の際、テーマを利用して容易に体裁を変更する事ができます。 さて、既存のSphinxのテーマを変更したくなる時とは、どのような場合でしょ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
