sphinx 記述方法

前回はドキュメント作成し記述できる状態まで出来たので今回は記述方法を学んで行こうと思います。

---

参考記事

---

第一歩目

まずは目次を作成し見出しに番号を振る

拡張子は省略できる

#index.rst
.. VBA_Documents documentation master file, created by
   sphinx-quickstart on Wed Apr 17 08:57:49 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

VBA_Documents's documentation!
=========================================

.. toctree::
   :numbered:

   /doc/page1
   /doc/page2
   /doc/page3

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

#page1.rst
###########################
Page1
###########################

***************************
段落が下がる-1
***************************

***************************
段落が下がる-2
***************************

***************************
段落が下がる-3
***************************

#page2.rst
###########################
Page2
###########################

***************************
段落が下がる-1
***************************

***************************
段落が下がる-2
***************************

***************************
段落が下がる-3
***************************

#page3.rst
###########################
Page3
###########################

***************************
段落が下がる-1
***************************

***************************
段落が下がる-2
***************************

***************************
段落が下がる-3
***************************

リテラルコードブロック

リテラルコードブロックは、行末に空白スペースを入れ、:: を記述することで行うことができる。　
インデントを3つ入れないとエラーが発生する。 ::

***************************
リテラルコードブロック
***************************
リテラルコードブロックは、行末に空白スペースを入れ、:: を記述することで行うことができる。　
インデントを3つ入れないとエラーが発生する。 ::

   ここからスタート
   TEST TEST TEST TEST TEST TEST TEST TEST
   TEST TEST TEST TEST TEST TEST TEST TEST

コード(空白行を一つ開けて記述する)

.. code-block::

.. code-block::
   print('Hello')