sphinx-me

스핑크스 - 나 프로젝트의 스핑크스 문서 쉘을 작성하고있는 README 문서의 인덱스와 같은 파일를 & nbsp 포함 파이썬 도구이다. 그러한에서 프로젝트 이름, 저자 및 버전으로 필요한 메타 데이터를 추출 처리하여 당신의 스핑크스 문서에 사용하기위한 프로젝트.
사용 후에는 스핑크스를-나 그런 다음 읽기 문서 도구 사이트에 프로젝트를 추가하고 프로젝트의 README은 매력적인 스핑크스 문서를 테마로 호스팅 할 수 있습니다, 당신의 스핑크스 문서를 빌드합니다.
참고 : README 파일은 reStructuredText 호환 형식이어야합니다.
설치
가장 쉬운 방법은 설치하는 스핑크스를-나 아래의 각각의 명령을 실행하여 PIP 또는 setuptools에를 사용하여 PyPI에서 직접입니다 :
설치 PIP -U 스핑크스 - 나
나 :
easy_install을 -U 스핑크스 나-에게
그렇지 않으면-나 스핑크스를 다운로드 할 수 있습니다 소스에서 직접 설치한다 :
파이썬 설치 setup.py
실행
스핑크스는-날 동안 프로젝트의 루트 디렉토리에있는 명령 줄에서 실행할 수있는 시스템 전체 스크립트로 설치됩니다
스핑크스 - 나
프로젝트의 디렉토리에 실행하면 두 개의 파일, 스핑크스 conf.py 모듈 및 프로젝트의 README를 포함 index.rst 파일과 문서 디렉토리를 생성합니다.
conf.py 모듈에서 설정 함수를 호출 스핑크스를-나를 당신의 스핑크스 문서의 최소 필수 설정을 설정합니다.
- 프로젝트 - 프로젝트의 디렉토리 이름이 사용됩니다.
- 버전 - 당신의 setup.py 스크립트, 또는 패키지의 __version__ 속성​​의 버전 인수에서 검색.
- 저작권 - 당신의 setup.py 스크립트, 또는 패키지의 __author__ 속성​​의 저자 인수에서 검색

요구 사항 : 있습니다.

파이썬