2012년 5월 13일 일요일

django , rst 파일을 위한 Sphinx



파이썬에 Sphinx 라는 Project가 있습니다.

이것은 reStructure 라는 format으로 작성된 문서를 

html 이나 기타 다른 문서 포맷으로 바꿔주는 파일입니다. 


출처는 위와 같고, 실제 최종 인스톨 방법은 저 사이트를 들어가서 확인하시면 되고, 


easy_install -U Sphinx

과 같이 작서하면 일단 설치는 끝납니다. 


여기서 tutorial 같은 내용은 안적겠습니다. 


일단 Sphinx는 메뉴얼 같은것을 만들 때 좋은 툴입니다. 

다만 이것이 static 으로 동작을 하기 때문에, 

온라인에서 바로 수정하고 하는 dynamic한 것이 지원이 되지 않습니다. 


sphinx 로 문서를 만들게 되면 우리가 흔히 보아왔던, 

아래 와 같은 문서들이 만들어 지게 됩니다.

맨 아래 보시면
아래와 같은 문구에서 Sphinx 로 작성이 되었다는 말을 확인할 수가 있죠, 

우리는 문서를 작성할때 structured Text (구조적으로) 작성하지는 않죠,

구조적인 글쓰기를 할때 매우 유용한 형태입니다.

그래서 외국 페이지를 보다보면,  매우 단순하면서도,

구조적으로 잘 갖춰져 있는 경우가 많더라고요,

우리 처럼 문서하나를 작성하더라도 워드같은걸로 작성하는 것이 아니라.

텍스트로 작성을 해서 그걸 doc, html로 변환시키는 접근법을 하는 사람들이 많더라고요

특정 플래폼에 종속되기 보다는 내용적인 면에 집중하게 되는 장점도 있고요,

암튼, 그런 구조적인 글쓰기를 지원해주는 Sphinx 라는 project 입니다.


댓글 없음:

댓글 쓰기