PYPI 용 스핑크스로 첫 번째 프로젝트를 패키징하고 있습니다. 나는 docs/source 폴더에있는 스핑크스 문서를 만들었습니다. 내 질문은 : 레포에 내장 된 문서를 제공하는 것이 관습입니까? 그것은 보통 어떻게 이루어 집니까?프로젝트에서 스핑크스 파일을 작성했습니다.
나는 많은 사람들이 스핑크스를 설치하거나 들리지 않았다고 상상할 수 있기 때문에 묻는다. 나는 그들의 삶을 편하게하고 싶다.
문서는 소프트웨어가 아닙니다.
README.rst 및 릴리스 노트를 제외하고는 설명서가 포함 된 PyPI 패키지에 대해 알지 못합니다. 문서가 포함될 수 있습니다.
패키지에 설명서가있는 경우 일반적으로 docs 폴더를 형제로 저장소의 패키지 원본 폴더에 넣습니다. 그런 다음 PyPI로 릴리즈 할 때 소스 폴더 만 업로드됩니다.
이제는 PyPI 릴리스에 문서를 포함 할 수 없다는 의미는 아니지만 불필요한 다운로드 시간과 사용자가 패키지를 설치 한 후 파일 시스템에서 설명서를 찾을 수 없음을 포함하여 일부 부정적인 점이 있습니다. 대안이 있습니다. Read the Docs은 저장소의 모든 변경 사항에 대한 문서를 작성하고 HTML (온라인 또는 다운로드 가능한 .zip), PDF 또는 ePub 형식으로 사용할 수 있도록 구성 할 수있는 인기있는 서비스입니다.
감사합니다. @ 스티브, 형제 님의 제안에 따라 패키지의 소스 폴더에'docs '를 넣을 것입니다. 그러나'MANIFEST.in'에서 나는 Sphinx 소스 파일이있는 곳에'docs/source/* '를 포함 시켰습니다. 내가해서는 안되는거야? – zeycus
Nope. 'docs'는'.rst' 파일을 저장하는 곳입니다. 'src' 또는'mypackage'는 패키지의 소스 코드를 저장하는 곳입니다. 일반적인 패턴은 [Pyramid repo] (https://github.com/pylons/pyramid)를 참조하십시오. 또한 해당 repo의 HACKING.txt에서 문서를 작성하는 방법에 대한 유용한 정보를 찾을 수 있습니다. –