객체 타입 선언¶
표준 도메인에 없는 이름이 필요할 수 있습니다. TOML에서 객체 타입을 선언하면 Guidedog가 Python 확장 없이 참조 대상, 색인 항목, 역할을 만듭니다. 선언은 문법을 나타내며 실행 동작은 아닙니다.
참조 대상: add_crossref_type¶
[[crossref_types]]
directive = "setting"
role = "setting"
index = "pair: %s; setting"
이후 .. setting:: DEBUG는 ID가 setting-DEBUG인 대상과 색인 항목을 만들고, :setting:`DEBUG`는 Sphinx처럼 이를 연결합니다. index는 Sphinx의 indextemplate에 해당합니다. 첫 콜론 앞에는 종류(single, pair, triple, see, seealso), 뒤에는 항목을 적으며 %s는 이름입니다.
설명: add_object_type¶
[[object_types]]
directive = "django-admin"
role = "djadmin"
index = "pair: %s; django-admin command"
name = "first-word"
display = "django-admin %s"
program = true
.. django-admin:: migrate [app_label]는 일반 객체처럼 시그니처, 본문, ID(django-admin-migrate), 색인 항목으로 명령을 설명합니다. Sphinx는 parse_node 함수로 시그니처를 읽을 수 있지만, 일반적인 처리는 다음 필드로 지정합니다.
name-
"whole"(기본값)은 전체 시그니처를 객체 이름으로 씁니다."first-word"는 첫 공백 앞까지를 씁니다. 예를 들어pdb의b(reak) [lineno]는b(reak)라는 이름을 갖습니다. display-
시그니처의 표시 방식이며
%s가 시그니처입니다. 기본값은 원문 그대로입니다. program-
true이면 이름이 이후 옵션이 속할 프로그램이 됩니다... program::와 같습니다.
지시문의 다른 이름¶
확장은 Sphinx의 지시문을 다른 이름으로 등록할 수 있습니다.
[directive_aliases]
django-admin-option = "option"
awaitablefunction = "py:function"
도메인이 없는 대상은 표준 지시문이나 기본 도메인의 지시문입니다. py:function 같은 대상은 도메인을 명시합니다.
마이그레이션¶
guidedog migrate는 conf.py에 나열된 프로젝트 내부 확장 모듈을 찾습니다. add_crossref_type, add_object_type, add_directive 호출을 실행하지 않고 읽어 표를 작성합니다. 선언할 수 없는 parse_node 함수(name, display, program으로 맞추어야 함)와 Python 지시문, 역할, 이벤트 처리기는 보고합니다.