Sphinx

처음 생성 할 때

이 주요 목적은 것은 파이썬의 자신의 코드에 대한 문서 발전기 역할을하는 것이 었습니다.
그 이후로,이 프로젝트는 언어에 상관없이 주위에 대부분의 자동 문서 생성기에서 가장 참조 된 영향 중 하나 인, 개발 세계에서 숭배 상태에 도달했습니다.
오늘날, 단지 파이썬 외에, 스핑크스는 또한뿐만 아니라 C 및 C ++ 코드와 함께 사용할 수 있습니다.

이 릴리스의 새로운 기능 :

C ++ 도메인에 편의 지침과 역할을 추가 지시자``CPP를 : var``을``CPP에 대한 별명으로 : member``, 역할``: CPP : var``을 별칭으로``에 대한 : CPP : member``을, 어떤 C ++ declaraction에 대한 상호 참조 및 역할`any`.
: confval은`source_suffix` 설정 값은 현재 여러 접미사 목록이 될 수 있습니다.
confval :`source_parsers` 설정 값과 소스 접미사 소스 파서를 지정할 수있는 기능을 추가합니다.
새로운 빌더, AppleHelpBuilder 애플 도움말 도서 빌드 추가되었습니다.

버전의 새로운 기능 1.2.3 / 1.3b3 :

스핑크스 버전의 프로그램 검사에 대한 추가``sphinx.version_info`` 튜플.

버전 1.1.3의 새로운 기능 :

confval : 일부 설정을 고정 충돌`modindex_common_prefix`.
``-D``의 고정 처리 및 파이썬 3에``-A`` 옵션.
대신 재귀 오류로 실행하는, 인식 및 순환 toctrees에 대해 경고한다.
docutils 트렁크와의 호환성을 복원합니다.
다시 고정 HTMLHELP 인덱스 항목 링크.
내장 명령에 속성 오류를 제기 고정 inheritance_diagram.
고정 충돌 용어집에 의견이나 고독한 약관을 놓을 때.
모든 스핑크스에 대한 고정 HTML 도움말 언어 / 인코딩 매핑 언어를 지원했다.

버전 1.1의 새로운 기능 :

기능이 추가 :
추가 파이썬 3.x를 지원.
새로운 빌더 및 서브 시스템.
호환되지 않는 변경 :
: RST : DIR :`평 : module` 지시어는 더 이상 그``platform`` 옵션 값을 출력하지 않습니다. (이 지시문은 출력을했다, 따라서 매우 일관성있는 유일한 일이었다.)
이전 종속 버전의 제거를 지원합니다.
새로운 로케일 :
스웨덴어 로켈을 추가했습니다.
이란 로케일을 추가했습니다.
라트비아어 로케일을 추가했습니다.
네팔어 로케일을 추가했습니다.
한국어 로켈을 추가했습니다.
에스토니아어 로케일을 추가했습니다.

버전 1.0.8의 새로운 기능 :

autosummary 세대 AttributeErrors에 대한 역 추적을 수정합니다.
약어가에 줄 바꿈이있는 경우``abbr`` 역할을 수정합니다.
사용자 정의 개체 유형의 검색 결과에 링크를 수정합니다.
정의되지 않은 참조에 대한 경고에보고 된 줄 번호를 수정합니다.
C ++ 배열 정의와 이름을 입력하지 않는 템플릿 인수를 수정합니다.
LaTeX의 출력 섹션 헤더에 각주를 허용합니다.
허용 키워드는 intersphinx 통해 연결합니다.
생산 목록 토큰 이름에 유니 코드 문자를 허용합니다.
텍스트와 남자에 대한 그림은 GraphVIZ 노드에 대한 더미 방문자를 추가합니다.
이미지 파일 복사 버그를 수정.
C ++ 도메인에 여러 개의 서명의 분석을 수정합니다.
소스 파일을 찾을 때 이맥스 잠금 파일을 무시합니다.
autodoc에서 가져올 수 모듈 .pyw 확장을 허용합니다.
빠른 생성 메이크에서 사용``$ (MAKE)``.
브라우저에서 사이드 바의 검색 상자 폭이 일치합니다.
HTML 출력의 중심 인물의 간격을 수정합니다.
sys.stderr에 그들을 인쇄 할 때 안전하게 SphinxError 메시지를 인코딩.
없는 부분이있는 문서 만 링크 대상 라텍스 출력 오류를 수정.
올바르게 autodoc의 방법으로 내장 방법 설명을 취급합니다.
파이썬 textwrap 모듈을 monkeypatching 중지합니다.
Viewcode 이제 비 ASCII 인코딩이 소스 파일을 올바르게 작동합니다.
모듈 지시어 : 평에서``noindex`` 플래그 옵션을 존중합니다.
첫 번째 : DIR :`literalinclude`에 존재하지 않는 행을 포함 할 때 IndexErrors을 수정합니다.
존경 사용자 정의 함수 / 메소드 매개 변수 분리 문자열.
jQuery를된다와 JS 호환성 수정, 1.5 =.
HTMLHELP .hhk 파일을 작성할 때 두 번 인코딩이 수행 수정.
구문 분석 - 문자 블록에 SmartyPants을 가하지 마십시오.
C ++ 도메인은 지금 배열 정의를 지원합니다.

버전 1.0.6의 새로운 기능 :

빈 상호 참조 대상에 대해 파이썬 도메인의 역 추적을 수정합니다.
크롬 브라우저에서 문자 블록 디스플레이 문제를 해결.
일반 인덱스와 용어집에 악센트 문자 제한된 범위의 정렬을 지원합니다.
로케일의 기본 인코딩으로```-D``와`-A`` 명령 줄 인수를 디코딩보십시오.
준수 : confval`locale_dirs`을 JS 변환 파일을 찾을 때.
LaTeX의 빌더 일본 문서의 더 나은 지원을 위해 특수 코드를 추가합니다.
# 77의 회귀 : PARAM :``로 주어진 하나의 매개 변수가있는 경우``마크 업, 글 머리 기호 목록은 이제 다시 억제된다.
특정 상황에서 LaTeX의 출력에서​​ 누락 된 단락 나누기를 수정합니다.
이 컨텐츠를 추가 할 수 있도록 문서화 문자열 없이도 객체에 대한``autodoc - 프로세스 docstring`` 이벤트를 방출한다.
LaTeX의 빌더에서뿐만 아니라, 문자 블록은 다른 테이블의 처리를 필요로하지만, 또한 꽤 많은 다른 목록과 같은 블록 요소.
유효한 서명이없는 파이썬 객체에 대한 viewcode 확장의 역 추적을 수정합니다.
docutils 버전에 따라 때문에 다른 행동, autodoc 포함 문서화 문자열에서 생성 된 경고를 줄 번호의 이상한 reportings을 수정합니다.
C ++ 도메인에 몇 가지 수정.

버전 1.0.5의 새로운 기능 :

정렬 이미지와 그림 docutils 0.7에 필요한 CSS 스타일을 추가합니다.
LaTeX의 출력에 의해 생성 된 메이크, 청소에 PDF 파일을 삭제하지 마십시오; 그들은 이미지를해야 할 수도 있습니다.
선 블록 생성 LaTeX의 출력을 수정합니다.
허용``소스 파일 확장자로 .pyw``.

버전 1.0.4의 새로운 기능 :

2 ZLIB 압축 된 데이터를 포함 버전 이후 Windows에서 바이너리 모드에서 열기 intersphinx 재고.
자바 스크립트 파일, 예를 들어 비 로컬 URI를 제공 허용 JSMath 확장한다.
intersphinx_mapping``가 비어있을 때``역 추적을 수정합니다.

버전 1.0.3의 새로운 기능 :

docutils 목차에서 오는 링크에 대한 내부 대 외부 링크의 차이를 수정합니다.
``toctree의``maxdepth`` 옵션을 수정 ()``템플릿 호출``붕괴 = True``과 함께 사용했을 때.
문자열 리터럴에 괄호를 포함하는 파이썬 인수 목록을 구문 분석 충돌을 수정합니다.
자막이없는 인물로 LaTeX의 문서를 만들 때 회귀를 수정합니다.
picklable되지 않는 클래스를 상속 다이어그램을 수정합니다.
쉽게 참조 할 수있게, 사이드 바 붕괴 버튼에 대한 별도의 배경색을 소개합니다.
몇 가지 기본 테마에 작은 레이아웃 버그를 수정.

버전 1.0.2의 새로운 기능 :

FUNC : 추가 유형의 개체에 대한 상호 참조를 수정`~ .Sphinx.add_object_type` API 함수를.
다른 지시자 유형에 대한 문서 필드 유형의 처리 수정.
반발 이스케이프 줄 바꿈을 계속, 긴 서명을 파괴 할 수 있습니다.
(때문에 Pygments 스타일과 네임 스페이스 충돌의) C 도메인 참조 원치 않는 스타일을 수정합니다.
명시 적 앵커와 PEP들과의 RFC에 대한 참조를 허용합니다.
그림에 LaTeX의 참조를 수정합니다.
비 정확한 검색을 수행 할 때, 객체의 지정된 형태와 일치합니다.
너무 모듈에 대한``.name`` 파이썬 참조 대상 비 정확한 검색을 적용합니다.
정보 필드 목록에서 매개 변수를 복제 할 때 충돌을 수정합니다.
``oldcmarkup`` 확장에서 제공하는 하나의 기본 역할 설정을 수정합니다.
JSON-평가 설치 될 때``json`` 모듈을 제공하지만 simplejson에 호환되는, 충돌을 수정합니다.
intersphinx에서 대상 이름의 처리를 고정합니다.
``의 제거를 수정!``모든 상호 참조 역할.

버전 1.0.1의 새로운 기능 :

나머지 도메인 객체 생성 된 대상 이름을 수정; 그들은 같은 공간에 있지 않습니다.
벵골어 언어를 추가합니다.
자바 스크립트 객체 이름을 구문 분석의 버그를 수정.
더 toctree이없는 경우 SingleHTMLBuilder 건물 수정.
명시 적 목표로 intersphinx에 링크 개체에 대한 표시 이름을 수정합니다.
JSON 빌더 건물 수정.
라텍스 오브젝트 설명에 hyperrefs을 수정합니다.

버전 1.0의 새로운 기능 :

일반 :
누락 된 모든 참조에 대한 경고를 방출하는 "nitpicky"모드를 추가했습니다. 옵션 :`-n` 명령 줄 스위치 나 : confval`nitpicky` 설정 값이이 활성화됩니다.
빠른 메이크에서 latexpdf`` 목표는``추가했습니다.
마크 업 :
: 첫 번째 : 역할은`menuselection`과 :이 첫 번째 : 역할 :`guilabel` 역할은 지금 앰퍼샌드 가속기를 지원합니다.
새로운 컴팩트 문서 필드 구문은 이제 인식 :``: PARAM 유형 이름을 : description``을.
첫 번째 :에 추가 된``탭 width`` 옵션 DIR :`literalinclude` 지시자.
첫 번째 : DIR :`toctree` 지시어에 추가 된``titlesonly`` 옵션.
첫 번째 : DIR :`literalinclude` 지침``prepend``과에``append`` 옵션을 추가했습니다.
모든 docinfo 메타 이제 문서 메타 데이터뿐만 아니라 저작 투입된다.
: RST : 역할 :`ref` 역할은 이제 자막으로 테이블을 참조 할 수 있습니다.
: RST : DIR :`include` 지시어는 현재 소스 디렉토리에 상대적으로 해석됩니다 절대 경로를 지원합니다.
파이썬 도메인에서``같은 참조 : FUNC은`지금 어떤 접두사와 일치하는 이름을 찾아 .name``` 직접 일치가 발견되지 않는 경우.
구성 :
추가 : confval`rst_prolog` 설정 값입니다.
추가 : confval : '섹션 번호 매기기 서식을 제어 할 수 html_secnumber_suffix`의 설정 값입니다.
추가 : confval`docutils '컴팩트 목록 기능을 제어 할 수 html_compact_lists` 설정 값입니다.
: confval은`html_sidebars`의 설정 값은 현재 키와 같은 패턴을 포함 할 수 있으며 값은 명시 적으로 사이드 바 템플릿을 렌더링해야하는 선택 목록이 될 수 있습니다. 즉, 내장 사이드 내용에만 선택적으로 포함될 수 있음을 의미한다.
: confval`html_static_path` 이제 단일 파일 항목을 포함 할 수 있습니다.
새 범용 설정 값 : confval : confval :`unused_docs` : confval`exclude_trees`과 : confval : 사용되지 않는`exclude_dirnames``exclude_patterns` 이전한다.
추가 : confval`html_output_encoding` 설정 값입니다.
confval : 추가 된`latex_docclass` 설정 값을하고 "twoside"documentclass 명령 옵션 "oneside"에 의해 재정의했다.
confval :`trim_doctest_flags` 설정 값, 기본적으로 사실을 추가했습니다.
추가 : confval`html_show_copyright` 설정 값입니다.
추가 : confval`latex_show_pagerefs`과 : confval`latex_show_urls` 설정 값.
confval :의 동작은`html_file_suffix`은 약간 변경 : 빈 문자열은 이제 "기본 접미사"에 대한 "접미사"대신 "기본 접미사"사용``None``을 의미합니다.
새로운 빌더 :
EPUB 형식의 빌더를 추가했습니다.
매뉴얼 페이지에 대한 빌더를 추가했습니다.
단일 파일 HTML 빌더를 추가했습니다.
HTML 출력 :
인라인 역할은 지금의 스타일이 자신의 모양을 사용자 정의 할 수 있도록, 자신의 이름을 가진 CSS 클래스를 얻을. 도메인 고유의 역할은 두 개의 클래스,``domain``와``도메인 rolename``를 얻을.
그들은 전체 프로젝트 내부의 경우 현재 페이지 내부에 반대 참조는 이제 internal`` 클래스를``얻을.
외부 참조는 기본 테마에 대한 새로운``externalrefs`` 테마 옵션을 사용하여 다른 스타일을 할 수 있습니다.
기본 테마에서, 사이드 바는 실험적으로 이제 새로운``collapsiblesidebar`` 테마 옵션을 사용하여 축소 할 수있다.
Toctrees 이제 HTML 출력의 클래스``toctree-wrapper``와``div`` 태그에 싸여있다.
: 데이터`템플릿 호출 이제 생성 된 트리의 깊이를 제어 할 수있는``maxdepth`` 키워드 인수를 가지고 toctree`.
: 데이터 :`템플릿 호출 toctree` 지금``titles_only`` 키워드 인수를 받아들입니다.
레이아웃 템플릿에 추가 된``htmltitle`` 블록.
자바 스크립트 검색에서``sys.argv``처럼, 모듈 이름을 포함하여 객체의 이름을 검색 할 수 있습니다.
하이쿠 OS 사용자 가이드에서 영감을 새로운 테마``haiku``을 추가했습니다.
추가 된 새로운 테마``nature``.
앤디 브레가 만든 추가 된 새로운 테마``agogo``.
아르 민 Ronacher에 의해 만들어진 추가 된 새로운 테마``scrolls``.
기본 테마로``visitedlinkcolor`` 테마 옵션을 추가했습니다.
비동기 thesearch 인덱스를로드하여 검색 페이지의 응답 성을 향상.
확장 API :
추가 : 이벤트 :`HTML - 수집 - pages`.
추가 : confval`needs_sphinx` 설정 값 : 메타 :`~ sphinx.application.Sphinx.require_sphinx` 응용 프로그램 API 방법.
추가 : 메타 :`~ sphinx.application.Sphinx.add_stylesheet` 응용 프로그램의 API 메소드.
확장 :
모드 :`~ sphinx.ext.viewcode` 확장을 추가했습니다.
모드 :`~ sphinx.ext.extlinks` 확장을 추가했습니다.
``autodoc_member_order =와 autodoc에 회원의 소스 순서에 대한 지원이 추가, 'bysource'``.
추가 : confval`autodoc_default_flags` 설정 값, 모든 autodoc 지침에 대한 기본 플래그를 선택할 수 있습니다.
intersphinx 다른 프로젝트의 이름이 라벨을 참조하고, 링크 할 프로젝트를 지정하는 방법을 추가했습니다.
지금 예를 문서화 할 수 Autodoc은``__init__`` 방법에 할당 된 속성.
모드 :에 많은 개선 및 수정`~ sphinx.ext.autosummary` 확장, 파울리 비르 타넨에 감사합니다.
: 모드 :`~ sphinx.ext.graphviz` 확장 할 수있는 대신 confval에 의해 제어 PNG 이미지의 현재 출력 SVG`graphviz_output_format` 설정 값입니다.
첫 번째 :에 추가 된``alt`` 옵션 DIR :`graphviz` 확장 지시.
FUNC :에 추가 된``exclude`` 인수`.autodoc.between`.
번역 :
추가 크로아티아어 번역, 보얀 Mihelac에 감사합니다.
추가 터키어 번역, Firat Ozgul에 감사합니다.
추가 카탈로니아 어 번역, 포 페르난데스에게 감사드립니다.
추가는 중국어 번역을 단순화.
추가 덴마크어 번역, Hjorth 라센에 감사합니다.
추가 리투아니아어 번역, Dalius Dobravolskas에 감사합니다.

버전 1.0b1에 새로운 기능 :

도메인에 대한 지원이 추가되었습니다. 도메인은 지침과 모든 개체는 예를 들어, 함께 속하는 기술 역할의 모음입니다 프로그래밍 언어의 요소. 몇 편입 도메인이 제공됩니다 - 파이썬 - C - C ++ - 자바 스크립트 - reStructuredText
C 지시어로 정의하고 연결에 대 한 오래 된 마크 업``oldcmarkup`` 확장을 활성화하지 않고 더 이상 작동하지 않습니다.
이전 종속 버전의 제거를 지원합니다.
사용되지 않는 요소를 제거.

버전 0.6.5의 새로운 기능 :

autodoc에서 명시 적으로 문서 주석을 사용하여 설명 일부 모듈 멤버의 누락을 수정합니다.
기본 테마의 stickysidebar`` 옵션``와 사이드 바 스크롤 바의 자르기를 수정합니다.
항상 퀵 스타트 메이크에서 유닉스 뉴 라인을 생성합니다.
Windows에서 -C````실행 수정.
autodoc에서는 내장기구 실패 객체의 서명을 정의 할 수 있습니다.
라텍스 시작 값을 열거 목록에 대한 출력을 수정합니다.
함께 사용하지 않을 경우 제대로``literalinclude`` 지시문 작업에``시작 after``과``최종 before`` 옵션을 확인합니다.
LaTeX의 빌더에서 링크 생성을 수정합니다.

버전 0.6.4의 새로운 기능 :

구성에서 비 유니 코드 문자열의 처리를 개선.
이해할 수없는 인수은 GraphVIZ를 호출 할 때 발생하는 캐치 OSErrors.
Pygments된다과의 호환성을 복원, 1.2 =.
LaTeX의 출력에 hyperref 대상의 탈출 수정.
DOC :``에 의해 생성 된 링크를 수정``LaTeX의 출력을위한 역할을.
전체 문서를 읽은 후 할 일 노드를 수집; 이 할 일 항목에 대체 참조를 배치 할 수 있습니다.
라텍스 빌드에서 명시 적으로``today``의 설정 값을 무시하지 마십시오.
상속 다이어그램의``alt`` 텍스트가 훨씬 청소기입니다.
링크 캡션을 생성 할 때 섹션 제목의 이미지를 무시합니다.
``doctest`` 확장의``testoutput`` 블록 지원 예외 메시지.
선 블록은 HTML 출력에서​​ 제대로 스타일된다.
다시``locale_dirs`` 설정 값 작업을했다.
````를 통해 명령 행에서 주어진 html_context`` 값은 -A``는 conf.py.에 주어진 다른 값을 대체해서는 안
``dirhtml`` 빌더 증가 재 구축을 방지하는 버그를 수정.
일부 문자 블록에 따옴표의 맹 글링을 수정합니다.
``dirhtml`` 빌더의 검색 인덱스에 경로를 수정합니다.
자이 썬의 호환성 문제를 해결 : 옵션``parser`` 모듈에 의존합니다.
autodoc에서뿐 아니라``ImportError``, 모듈 가져 오기에 발생하는 모든 오류를 잡을 수있어.
autodoc에서 비 데이터의 처리 만이 아닌 방법 설명을 수정합니다.
파일 시간을 복사 할 때, ()``os.utime``에 의해 제기 OSErrors을 무시합니다.

요구 사항 :

1.2 이상을 Pygments
신사 2.3 이상
Docutils 0/7 이상