2013-01-16 3 views
0

특별히 잘 설명되지 않은 작은 Python 코드베이스에 대해 "인터페이스 제어 문서"를 작성하려고합니다. 현재 위치의 문서 스키마에 적합하려면 플랫 한 Word 문서로 제공해야합니다. 대부분 코드에서 추출해야합니다.Python을 MS Word에서 읽을 수있는 형식으로 문서화

지금까지 유일한 후보는 doxygen의 .rtf 기능입니다. 그리고 doxygen은 파이썬과 비슷합니다. 그리고 rtf와 함께. 그래서. 누구든지 더 나은 해결책을 제안 할 수 있습니까?

답변

2

파이썬 커뮤니티는 ReST 형식의 강력한 지지자입니다. 방대한 워드 문서를 다뤄야 만하고 난 후에 그것을 좋아하게되었습니다. Sphinx은 프로젝트를 문서화하는 데 사용할 수있는 훌륭한 문서 도구이며 http://readthedocs.org에 의해 사용됩니다. 그러나 작은 프로젝트를 설정하는 데는 다소 도움이 될 수 있습니다.

ReST으로 글을 작성하고 pandoc을 통해 어떻게 단어로 변환하는지 확인하는 것이 좋습니다. 당신이 단어를 쓰기 피하고 싶은 경우에 당신이 형식을 많이 가지고

그리고 정말, 단어 등 다양한 형식으로 다음과 같은 형식을 변환 pandoc 지원하므로 문서를 작성할 수 있습니다

  • 인하
  • reStructuredText (나머지)
  • 섬유
  • HTML
  • 의 DocBook
  • 유액
+0

ahah! 마법의 단어는 "판도르"입니다! 감사! – phunctor

관련 문제