sphinx覚え書き

いろんなメモをフォルダにばらまいておくのは
後で分からなくなるのでまとめたいなぁと思っていました。
wikiはいいシステムですが、さっと手が出なかったのでsphinx
を使ってみました。
まだ全然しょぼいのですが、
make html後のページを見ると
かっこ良くまとまっていてやる気になりました。
ちょっと色々と練習してみます。

index.rst
にはファイルのリストを指定します。


Welcome to sandbox's documentation!
===================================

Contents:

.. toctree::
   :maxdepth: 2
   
   test

   test2

   test3

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

テーブルはCSVフォーマットで作るには
.. csv-table:: ディレクティブを使うといいようです。

==============
日本語てすと
==============

:Author: iwatobipen

テーブルをつくろう
===================

*テーブル1*

.. csv-table::
   :header-rows: 1
   :widths: 2,6

   種別,タイトル
   サプリメント,グランドクロス
   リプレイ,アウターエッジ
   リプレイ,ビューティフルデイ

画像は.. image:: ディレクティブを使うとうまく行きました。

==============
日本語てすと2
==============

:Author: iwatobipen

画像を取り扱う
===================

*練習1*

.. |logo| image:: ./image/sphinx.png
   :scale: 50

* |logo| ロゴ入れこみの例

テスト






.. image:: ./image/python.png
   :scale: 40
   :alt: python
   :align: right


テスト テスト

|
|
|
|
|

テスト

コードブロックは
.. code-block:: 言語
でいいみたいです。

===============
コードブロック
===============

:Author: iwatobipen

Pythonic Code
===================

*コードブロック*

.. code-block:: python

   from rdkit import Chem
   mol = Chem.MolFromSmiles("CCC")

[/sourcecode]

全部作成後
make html でドキュメントが作成されます。
エラーがあるとそこがちゃんと見えるのでいい感じです。
もう少し勉強しようと思います。

広告

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト / 変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト / 変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト / 変更 )

Google+ フォト

Google+ アカウントを使ってコメントしています。 ログアウト / 変更 )

%s と連携中