이 페이지의 내용

Guidedog / 문서 0.2.0

Sphinx 프로젝트 옮기기

Guidedog은 Sphinx의 프로젝트 구조와 여러 설정 이름을 따르지만 conf.py나 Python 확장은 실행하지 않는다. 이관은 데이터와 실행 가능한 설정을 분리하는 데서 시작한다.

guidedog migrate path/to/conf.py
guidedog build html path/to/docs --diagnostics=json

migrate는 리터럴 설정을 읽어 conf.toml에 쓴다. 사람이 선택해야 하는 계산된 값은 보고한다. 값을 알아내려고 프로젝트를 가져오거나 Python을 실행하지 않는다. 동등한 설정으로 취급하기 전에 결과를 검토한다.

세 단계로 진행하기

1. 문서 그래프를 올바르게 구성하세요. 루트, 확장자, 제외 규칙, include를 확인합니다.
2. 참조를 올바르게 구성하세요. 도메인, 인벤토리, 사용자 정의 객체 타입을 확인합니다.
3. 표현을 올바르게 구성하세요. 템플릿, 다이어그램, 수식, 두 출력을 확인합니다.

알 수 없는 지시문은 프로젝트의 비공개 확장에 속할 수 있다. HTML 빌드 성공이 그 의미까지 재현되었음을 증명하지는 않는다. 진단을 읽고 지시문 대체, 지원되는 별칭 설정, 제한 사항을 기록한 유지 중 하나를 선택한다.

지원 범위와 CPython, Django, Flask 검증 자료는 Sphinx 호환성를 참고한다. 선언형 사용자 객체는 객체 타입 선언를 참고한다.