sphinxcontrib-taglist

sphinxcontrib - taglist는 스핑크스 "taglist"확장입니다.
TagList
Taglist는 스핑크스 문서 시스템의 확장입니다.
설치
주사위를 통해 INSTALATION :
sphinxcontrib - taglist를 설치 PIP
또는 github의를 통해 :
자식 복제 https://github.com/spinus/sphinxcontrib-taglist
CD를 sphinxcontrib - taglist
파이썬 setup.py 설치
다음으로, 당신은 당신의 스핑크스 프로젝트 'conf.py'에 확장자를 추가해야합니다.
확장 = [
& NBSP; ...,
& NBSP; 'sphinxcontrib.taglist'
& NBSP; ...]
구성
이 확장자를 가진 태그를 사용하는 경우 각 태그를 다른 색을 제공 할 수 있습니다. 당신은 추가하여 'conf.py'에서 해당 작업을 수행 할 수 있습니다 :
taglist_tags = {
& NBSP; '이 tag1': { '배경색': '녹색'}
}
지침
태그 :
& NBSP; 태그 지시어는 정보의 '조각'을 추가하고 당신이 그것을에 태그를 추가 할 수 있습니다.
& NBSP는, 당신은 그것을처럼 사용할 수 있습니다 :
& NBSP; .. 태그 : 일부 태그 정보
& NBSP; 태그 : tag1로이 tag2의 TAG3
& NBSP을하거나 :
& NBSP; .. 태그 : [이 tag1이 tag2의 TAG3] 일부 태그 정보
& NBSP; 경고 : 첫 번째 방법은 아닌 경우 두 번째 방법은 사용된다.
& NBSP; 경고 :이 구문 확실하지 않다, 그것은 변경 될 수 있습니다. 당신이 애니의 제안이 있으면 알려 주시기 바랍니다.
taglist :
& NBSP; taglist 태그를 잡아 목록을 지시어이다.
& NBSP; 첫째는 '태그 : ...'인쇄에서 표시하며,이 목록을 보여줍니다보다 태그 정보.
& NBSP는, 당신은 그것을처럼 사용할 수 있습니다 :
& NBSP; .. taglist ::
& NBSP; 태그 : tag1로의 TAG3
그것은 어떻게 작동 하는가?
그것은 비슷한 방식으로 작동하므로 코드베이스 sphinxcontrib - 요구 사항에서 파생됩니다.
문서 동안 독서 태그 지시자는 tag_node`s을 만듭니다. `taglist는 taglist 노드를 작성합니다.
taglist 노드를 해결하는 동안 텍스트 태그의 조각으로 변경되어 그 목록에 표시됩니다 태그 항목. 다음 모든 태그 항목을 인쇄합니다.
CSS
taglist.css :
& NBSP는,이 태그에 대한 기본 클래스를 포함 - taglist_tag을
& NBSP; 경고 : 그것은 아마 변경 및 taglist_tags.css에 배치됩니다. (그리고 conf.py에서 구성 할 수 있습니다)
또한, 처리 중에 파일 taglist_tags.css을 만듭니다 (당신이 conf.py에 정의 된 각 태그에 대한 CSS로, taglist_tags CSS를 키에 모든 태그 키를 매핑). 정적 파일 디렉토리를 구축하는 데 쓰기

요구 사항 :

이 파이썬
스핑크스