Tinkerer - Sphinx

reStructuredText

Sphinxで使われている軽量マークアップ。

Markdownより洗練されている感じ。

ReSTとかRSTとか呼ばれたりしてる。

Pygments

コードハイライトにはPygmentsが使われています。

Sphinxのドキュメントに詳しく書いてある。

コードサンプルの表示 — Sphinx v1.0.6 documentation

Contents

Sphinxで目次を付けれる。

.. contents:: 目次のタイトル？
     :depth: 2

Sphinxは色々なことを叶えてくれる。

ページ内の目次を作りたい :: ドキュメンテーションツール スフィンクス Sphinx-users.jp

ReST

reStructuredTextの基本だけならSphinxのドキュメントにある。

reStructuredText入門 — Sphinx v1.0 (hg) documentation

reStructuredTextについての詳細については日本語全訳があった。

はやわかり reStructuredText

Error Report

  • 1行目の見出し以外に”=”下線による見出しを作るとエラーが出てtinkerer -bが終了できないので注意。
投稿者 Yuya Yano
タグ: sphinx

最近の投稿

タグクラウド

c   c++   centos   Centos   CI   design   Django   emacs   fortran   heroku   hg   life   linux   Linux   mac   memo   MemoMemo   mercurial   MySQL   Poem   Python   python   Qt   rake   ruby   Rust   screen   sphinx   TDD   TestingFramework   tinkerer   Ubuntu   Unity   vim   vps

About me

@yymm ( @yymm6666 )
My name is Yuya Yano. I'm developer. I love dev! coding!
  • Language: Python/C/C++/C#/Javascript
  • Interested: Go/Rust/CL/Scheme/Scala/VimL
  • Environment: Ubuntu/Vim/tmux/mosh