sphinxで使えるディレクティブ集#

  • ディレクティブとはマークアップ言語における一般的なブロックのことです

toctree#

  • Table of contentsの略

  • toctreeに指定できない文字列

    • genindex

    • modindex

    • search

    • _(アンダースコア) で始まる名前

ディレクティブ:

.. toctree::
  :maxdepth: 2
  :numbered:
  :caption: caption text
  :name: name text
  :titlesonly:
  :glob:
  :hidden:
  :includehidden:

  intro
  All about strings <strings>
  datatypes
  intro*
  recipe/*

code-block#

例:

.. code-block:: python
  :caption: サンプル
  :linenos:
  :emphasize-lines: 4

  def factorial(x):
    if x == 0:
        return 1
        # 強調
    else:
        return x * factorial(x - 1)

出力

サンプル#
1def factorial(x):
2  if x == 0:
3      return 1
4      # 強調
5  else:
6      return x * factorial(x - 1)

todo#

ディレクティブ:

.. todo:: ディレクティブ紹介例に掲載のTODO

レンダリング後:

課題

ディレクティブ紹介例に掲載のTODO

todolist#

ディレクティブ:

.. todolist::

レンダリング後:

課題

ディレクティブ紹介例に掲載のTODO

(元のエントリ は、 /opt/build/repo/docs/tools/sphinx/directives.rst の 73 行目です)

code#

ディレクティブ:

.. code-block:: shell

  echo Hello world

レンダリング後:

echo Hello world

image#

ディレクティブ:

.. image:: https://unsplash.it/336/280/?random

レンダリング後:

https://unsplash.it/336/280/?random

figure#

ディレクティブ:

.. figure:: /_static/logo.png

レンダリング後:

../../_images/logo.png

admonition#

ディレクティブ:

.. admonition:: lorem30

Lorem ipsum dolor sit amet consectetur adipisicing elit. Recusandae placeat quia, magnam iusto cum beatae adipisci. Omnis nisi alias dolor. Quidem et fugiat minima saepe atque sed totam quibusdam perspiciatis!

レンダリング後:

lorem30

Lorem ipsum dolor sit amet consectetur adipisicing elit. Recusandae placeat quia, magnam iusto cum beatae adipisci. Omnis nisi alias dolor. Quidem et fugiat minima saepe atque sed totam quibusdam perspiciatis!

attention#

ディレクティブ:

.. attention:: attention

レンダリング後:

注意

attention

note#

ディレクティブ:

.. note:: note

レンダリング後:

注釈

note

warning#

ディレクティブ:

.. warning:: warning

レンダリング後:

警告

warning

error#

ディレクティブ:

.. error:: error

レンダリング後:

エラー

error

hint#

ディレクティブ:

.. hint:: hint

レンダリング後:

ヒント

hint

important#

ディレクティブ:

.. important:: important

レンダリング後:

重要

important

caution#

ディレクティブ:

.. caution:: caution

レンダリング後:

注意

caution

danger#

ディレクティブ:

.. danger:: danger

レンダリング後:

危険

danger

tip#

ディレクティブ:

.. tip:: tip

レンダリング後:

Tip

tip

rubric#

ディレクティブ:

.. rubric:: rubric

レンダリング後:

rubric

math#

ディレクティブ:

:math:`\sqrt{16}`

レンダリング後:

\(\sqrt{16}\)

command#

ディレクティブ:

:command:`Title`

レンダリング後:

Title

file#

ディレクティブ:

:file:`path`

レンダリング後:

path

guilabel#

ディレクティブ:

:guilabel:`Title`

レンダリング後:

Title

key#

ディレクティブ:

:kbd:`shortcut`

レンダリング後:

shortcut