0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

sphinx 記述方法

Last updated at Posted at 2024-04-17

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


参考記事


第一歩目

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

image.png

拡張子は省略できる
#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

image.png

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

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

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?