[컴][문서] 문서화

문서화 / 코드를 문서로 / api 문서화 / 문서 만들기 / 자동으로 문서만들기 / documentation / source code documentation


Open source code 의 문서화를 손쉽게 해주는 project 가 있는 듯 하다. 아래 얘기하는 Read The Docs 는 github 에 특정 형식(reStructuredText, Markdown) 으로 올리면 그것을 가져다가 .html 로 변환해서 hosting 해주는 듯 하다. 아직 사용하지 않아서 일단 대략적으로 정리만 해 놓는다.

Read The Docs

위 같은 모양이 Read The Docs Theme 이다. 일단 reStructuredText 나 Markdown 로 문서를 써놓고, 이녀석을 github 등에 올린 후에 ref. 1 를 이용하면 될 듯 하다.

실제로 해보고 다시 글을 써야겠다.

Read The Docs 는 reStructuredText 로 쓰여진 Sphinx 문서를 지원하고, Markdown 로 쓰여진 MkDocs 문서를 지원한다.

References

1. http://docs.readthedocs.org/en/latest/