ReStructuredText
Jump to navigation
Jump to search
Overview
reStructuredText 사용법 정리.
문서를 Git 이나 다른 형상관리툴로 관리하기에는 많은 어려움이 있다. 간단하게 문서 내용을 업데이트하고, 저장소 에 push 했을때, 문서의 어떤 내용이 변경되었는지 알기가 어렵다. reStructuredText 가 이에 대한 해답이 될 수도 있다.
Examples of reST markup
Headers
Section Header ============== Subsection Header -----------------
Lists
- A bullet list item
- Second item
- A sub item
- Spacing between items creates separate lists
- Third item
1) An enumerated list item
2) Second item
a) Sub item that goes on at length and thus needs
to be wrapped. Note the indentation that must
match the beginning of the text, not the
enumerator.
i) List items can even include
paragraph breaks.
3) Third item
#) Another enumerated list item
#) Second item
Images
.. image:: /path/to/image.jpg
Named links
A sentence with links to Wikipedia_ and the `Linux kernel archive`_. .. _Wikipedia: http://www.wikipedia.org/ .. _Linux kernel archive: http://www.kernel.org/
Anonymous links
Another sentence with an `anonymous link to the Python website`__. __ https://www.python.org/
N.B.: named links and anonymous links are enclosed in grave accents (`), and not in apostrophes (').
Literal blocks
::
some literal text
This may also be used inline at the end of a paragraph, like so::
some more literal text
.. code:: python
<source lang="python" enclose="none">
print("A literal block directive explicitly marked as python code")
</source>
See also
- Sphinx (documentation generator)
- Comparison of documentation generators
- Comparison of notetaking software
- Comparison of document markup languages
- Setext, an old lightweight markup language (1992).
- Markdown, a widespread lightweight markup language.
- MultiMarkdown, an improved Markdown.
- Org-mode, a similar lightweight markup.
- Textile (markup language), a similar lightweight markup language to produce HTML.
- AsciiDoc, a similar lightweight markup language supporting many types of documents.
- txt2tags, another similar lightweight markup language.
References
<references />