sphinx에서 생성 된 html 문서를 github으로 업로드하는 방법은 무엇입니까?

Question

필자는 많은 코드를 문서화했으며 스핑크스를 사용하여 문서를 생성하는 방법을 배웠다. 내 github 프로젝트 페이지에 포함시키고 싶지만 어떻게 해야할지 모르겠습니다. 누구든지 기존 튜토리얼이나 간단한 단계를 알고 있습니까?

감사합니다.

Answer 1

github은 github pages 기능을 사용하여 정적 콘텐츠를 제공합니다. 기본적으로 정적 페이지를 커밋하는 gh-pages라는 분기를 만듭니다. 이 페이지는 you.github.com/yourproject에서 제공됩니다.

http://pages.github.com/의 지침을 참조하십시오.

스핑크스는 밑줄이있는 디렉토리를 사용하므로 github에서 Sphinx를 사용하여 문제가 발생할 가능성이 높습니다. 생성 된 sphinx html로 디렉토리에 .nojekyll이라는 파일을 추가하여이 문제를 해결할 수 있습니다.

paver gh_pages_create gh_pages_build 

프로젝트를 위해 그것을 설정하는 방법에 대한 excellent documentation (물론 자체를 사용)를 참조하십시오

Answer 2

github-tools은 당신이 요구하는 것을 정확히 수행 기능이 있습니다.

Answer 3

John Paulett's answer은 분명하고 이미 대부분의 사용자 (+1)에게 충분할 것입니다.

또는 당신 단계별 지침뿐만 아니라 신속하게 에 시작하여 코드 [함께 문서를 게시 얻기 위해서 함께 사람들을 묶는 편리한 Fabric 기반 스크립트/작업을 제공 벤 웨일스어의 철저한 튜토리얼 Sphinx documentation on GitHub을 확인 할 수 있습니다. ..] 한 명령을 통해.