Command¶
builtin¶
sphinx-quickstart¶
ひな型になる conf.py の生成など。
index.rst
.. tmp documentation master file, created by
sphinx-quickstart on Sat Feb 19 18:06:59 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to tmp's documentation!
===============================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Sphinxはいくつかのドキュメント名を、自分で使用するために予約済み
genindex
index ディレクティブ
modindex
autodoc の一覧を表示。
モジュールインデックスには rst:dir:module ディレクティブで指定されたエントリーが含まれます
search
conf.py
project = 'tmp'
copyright = '2022, me'
author = 'me'
extensions = [
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_theme = 'alabaster'
html_static_path = ['_static']
sphinx-build¶
html の生成など