RST

RST

Creator

Creator

Seonglae Cho

Created

Created

2020 Aug 27 3:46

Editor

Editor

Seonglae Cho

Edited

Edited

2022 Nov 7 23:49

Refs

Refs

Restricted Text

like md, rst is pytho doc

python 문서화를 위해 만들었지만 많이 쓰인다 (심지어 리눅스 공식 문서도..)

[Pycon KR 2017] Rst와 함께하는 Python 문서 작성 & OpenStack 문서 활용 사례

Published on 많은 Python 패키지 및 라이브러리 문서들은 일반적으로 GitHub 등에서 사용하는 Markdown 문법이 아닌, rst (Restructured Text) 문법을 사용하여 작성이 이루어지며, Sphinx 라이브러리를 활용하여 html 또는 pdf로 build하여 해당 패키지 및 라이브러리 문서화를 관리하고 있습니다. 본 발표에서는 rst가 무엇인지부터 시작하여, rst와 관련된 기본 문법을 통해 html 또는 pdf로 어떻게 생성할 수 있는지 각 단계별로 살펴봄으로써 Python 문서화가 이루어지는 전반적인 과정을 먼저 살펴봅니다.

[Pycon KR 2017] Rst와 함께하는 Python 문서 작성 & OpenStack 문서 활용 사례

https://www.slideshare.net/ianychoi/pycon-kr-2017-rst-python-openstack

[Pycon KR 2017] Rst와 함께하는 Python 문서 작성 & OpenStack 문서 활용 사례

Recommendations

///////