코딩일지(2024-05-08)

restructured text,, 교수님께서 즐겨 쓰신다는데 뭐지?

---

restructured text.. 마크다운 같은건가?

잘은 모르겠는데, 저번에 교수님이 말한 sphinx라는 개발문서 전용 라이브러리를 위한 문서화 언어인것 같다. 마크다운 비슷한거같은디??

교수님의 문서화 프로젝트(rx003)에 기여하기 전에 일단 내가 별도로 구축방법이라던가 튜토리얼을 진행해볼라 칸다.

해당 블로그(링크)를 참고하여 튜토리얼을 학습했다.

1.우선 설치부터!

pip install Sphinx

2.빠른 시작!

sphinx-quickstart

여러가지 입력하는게 있었는데, 나는 요렇게 했다.

일단 [y/n] 뜨길래 그냥 무지성 yes,

project name: rx004

author: jacksmith

version: 1.0.0

lang: ko

그랬더니, 아래와 같이 빌드랑 소스라고 하는 두개의 폴더가 생성되었다.

블로그를 보면 source폴더가 중요하다 카는데, 일단 넘어가자.

3.html 만들기!

make html

위 명령어를 실행하여 source에 있는 파일을 결과파일로 바꿔주었다.

그래서 그런지, build안에 결과파일로 html이 만들어져 있었다.

4.html 문서 확인해보기!

start ./build/html/index.html

위 명령어를 실행하여 해당 경로에 담겨있는 문서 초기 결과물을 확인해보았다.

위 (링크)에서 sphinx에 적용한 다양한 테마들을 확인할수있다고 한다.