Paragraph Test of Sphinx

Section 구성 방법, 강조(굵게, 기울임), 번호 매기기 등등 문단을 디자인하는데 있어서 필요한 기능들을 익혀볼 것이다.

Section

Section은 section 제목에 밑줄(underline)을 그어서 만들 수 있다. (윗줄은 옵션)

  • #: Parts, 윗줄도 필요하다.
  • *: Chapters, 윗줄도 필요하다.
  • =: Sections
  • -: Subsections
  • ^: Subsubsections
  • ": Paragraphs

예시

#####
Parts
#####

*********
Chapters
*********

Sections
========

Subsections
-----------

Subsections
^^^^^^^^^^^

Paragraphs
""""""""""

Highlight

주의할 점은 non-word 문자로 둘러싸여 있어야 한다는 것이다. 다만, backslash를 이용해서 space를 없앨 수 있다.

  • 기울임: *bold*
    결과: bold
  • 굵게: **italic**
    결과: italic
  • 간단한 code sample: ``code sample``
    결과: code sample
  • space 없애기: thisis\ **one**\ word
    결과: thisisoneword

Numbering

다음과 같이 번호 및 글머리 기호를 만들 수 있다. #은 자동으로 번호를 매겨준다.

예시

1. 번호 매기기 1
2. 번호 매기기 2
#. 번호 매기기 3번

* 글머리 기호
* 글머리 기호

   * 글머리 기호 - 들여쓰기

#. 번호 매기기

결과

  1. 번호 매기기 1번
  2. 번호 매기기 2번
  3. 번호 매기기 3번
  • 글머리 기호

  • 글머리 기호

    • 글머리 기호 - 들여쓰기
  1. 번호 매기기

Definition List

말 그대로, 단어 같은 것을 정의하고자 할 때 쓸 수 있는 형식이다. 정의할 용어와 그에 대한 설명으로 이루어진다.

예시

정의
   (명사) 어떤 말이나 사물의 뜻을 명백히 밝혀 규정함. 또는  .

결과

정의
(명사) 어떤 말이나 사물의 뜻을 명백히 밝혀 규정함. 또는 그 뜻.

Field List

데이터 베이스 같은 형식으로 표현할 때 사용한다.

예시

:제목: 여행의 이유
:저자: 김영하
:출판사: 문학동네
:책 소개:
   여행이 내 인생이었고, 인생이 곧 여행이었다!

결과

제목:여행의 이유
저자:김영하
출판사:문학동네
책 소개:여행이 내 인생이었고, 인생이 곧 여행이었다!

Line Block

Source code에서 줄바꿈을 했어도, 실제 문서 파일을 만들면 줄바꿈이 되어 있지 않고 이어져있다. Line Block을 이용하면, source code에 있는대로 문서화된다.

예시

Before line block

2019
4
25

After line block

| 2019
| 4
| 25

결과

Before line block

2019년 4월 25일

After line block

2019년
4월
25일

Literal Block

텍스트 상자를 삽입한다. 삽입할 위치의 직전 단락을 ::로 끝마치면 된다. 전 단락과 텍스트 상자 사이는 한 줄 띄어야 하고, 텍스트 상자에 들어갈 내용은 꼭 indent 되어야 한다. (Indentation = 3 spaces)

예시

텍스트 상자 예시::

   삽입 내용

텍스트 상자 예시 2 ::

   삽입 내용 2

결과

텍스트 상자 예시:

삽입 내용

텍스트 상자 예시 2

삽입 내용 2