3. ロールやディレクティブの練習¶

3.1. ロール¶

詳細 : http://docs.sphinx-users.jp/markup/inline.html

サンプル:

* これが :title:`titleロール` です。
* これが :emphasis:`emphasisロール` です。
* これが :literal:`literalロール` です。
* これが :strong:`strong ロール` です。
* これが :sub:`subscript ロール(下付き文字)` です。
* これが :sup:`superscript ロール(上付き文字)` です。
* これが rfc ロールです。 : :rfc:`2616`
* これが abbr ロールです。 :abbr:`TLS (Transport Layer Security)`
* これが command ロールです。 :command:`/usr/sbin/chkconfig`
* これが file ロールです。 :file:`/etc/hosts`
* これが kbd ロールです。 :kbd:`Ctrl-C`
* これが manpage ロールです。 :manpage:`ls(1)`
* これが mimetype ロールです。 :mimetype:`text/plain`
* これが mailheader ロールです。 :mimetype:`Subject`
* これが regexp ロールです。 :regexp:`abc.{3}[-_0-9][^ABC](?:hello\\s\'\"\`world\`\"\')`

→

• これが titleロール です。
• これが emphasisロール です。
• これが literalロール です。
• これが rfc ロールです。 : RFC 2616
• これが strong ロール です。
• これが _{subscript ロール(下付き文字)} です。
• これが ^{superscript ロール(上付き文字)} です。
• これが abbr ロールです。 TLS
• これが command ロールです。 /usr/sbin/chkconfig
• これが file ロールです。 /etc/hosts
• これが kbd ロールです。 Ctrl-C
• これが manpage ロールです。 ls(1)
• これが mimetype ロールです。 text/plain
• これが mailheader ロールです。 Subject
• これが regexp ロールです。 abc.{3}[-_0-9][^ABC](?:hello\s'"`world`"')

3.2. 図表番号(numfig/numref)¶

• Sphinx 1.3 以上で対応された numfig (:numref:) を使っています。HTMLとLaTeXビルダーが対応。
• http://docs.sphinx-users.jp/markup/inline.html#cross-referencing-figures-by-figure-number
• http://docs.sphinx-users.jp/config.html#confval-numfig
• 図番号参照
  • 図の別名参照( 3.2.1 )
  • 図番号 - 3.2.2
  • 図番号 - 3.2.3
• 表番号参照
  • 表の別名参照( 3.2.1 )
  • 表番号 - 3.2.2
  • 表番号 - 3.2.3
• code-block参照
  • code-blockの別名参照( 3.2.1 )
  • ソースコード番号 - 3.2.2
  • ソースコード番号 - 3.2.3

図番号 - 3.2.1 画像のキャプション1 画像のキャプション1

図番号 - 3.2.2 画像のキャプション2 画像のキャプション2

図番号 - 3.2.3 画像のキャプション3 画像のキャプション3

1
2
3

$ cd /etc
$ sudo yum update
$ sudo systemctl start httpd

1
2
3
4
5

public class Main {
    public staic void main(String[] args) {
        System.out.println("Hello, Java");
    }
}

1
2
3
4
5
6

#include <stdio.h>

int main(int argc, char *argv[]) {
    printf("Hello, C\n");
    return 0;
}

3.3. ディレクティブ¶

.. meta::
   :token1: 1234567890 ABCD
   :token2: 1234567890 ABCD

.. title:: <s>"ロール'&</s>やディレクティブの練習
   タイトルの上書き

.. raw:: html

  <s>HTMLベタ書き</s>
  <s>HTMLベタ書き</s>

  <s>HTMLベタ書き</s>
  <s>HTMLベタ書き</s>

.. |mycheck| raw:: html

  <input type="checkbox" name="mycheckbox" value="on">My CheckBox</input>

.. |myradio| raw:: html

  <input type="radio" name="myradio">My RadioButton</input>

====== ==========
name   form
====== ==========
radio1 |myradio|
radio2 |myradio|
radio3 |myradio|
check1 |mycheck|
check2 |mycheck|
check3 |mycheck|
====== ==========

* :envvar:`PATH`
* :envvar:`EDITOR`
* :envvar:`PAGER`
* :envvar:`JAVA_HOME`

*強調(italic)*/**強い強調(bold)**/``リテラル表記``::

  * *強調(italic)*
  * **強い強調(bold)**
  * ``リテラル表記``

→

* *強調(italic)*
* **強い強調(bold)**
* ``リテラル表記``

aaaaaaaaaaaa
bbbbbbbbbbbbbb

#include <stdio.h>

int main(int argc, char *argv[]) {
    printf("Hello, World!\n");
    return 0;
}

public class demo {
    public static void main(String[] args) {
        System.out.println("hello, java");
    }
}

1
2
3
4
5
6

#include <stdio.h>

int main(int argc, char *argv[]) {
    printf("Hello, World!\n");
    return 0;
}

1
2
3
4
5

public class demo {
    public static void main(String[] args) {
        System.out.println("hello, java");
    }
}

3.4. TODOs¶

3.5. 章節番号の設定¶

目次への出力:

.. toctree::
  :maxdepth: 2
  :numbered:

またはrstファイルごとに以下のディレクティブを設定する:

.. section-numbering::

ただし、出力形式によって付いたり付かなかったり、あるいはTOCには付くが :doc: や :ref: への参照では付かなかったりと、ちょっと動作がわかりづらいところがあるので、実際に使うときは色々検証してみる必要がありそう。

また、sectnum (section-numbering はこれのsynonyms) は「使用しないでください」と書いてあるので、やめたほうが良いのかもしれない。 via: http://docs.sphinx-users.jp/rest.html#directives

参考:

• http://docutils.sourceforge.net/docs/ref/rst/directives.html#automatic-section-numbering
• http://sphinx-users.jp/reverse-dict/writing/numbering.html
• http://qiita.com/H-A-L/items/f38f849cc20faefb9fe6