Sphinx에서 매뉴얼 페이지로 렌더링되어야하는 재구성 된 텍스트의 옵션 목록을 어떻게 포맷합니까?

Question

명령 줄 도구의 설명서를 구조화 된 텍스트로 작성할 계획입니다. 나는 스핑크스를 사용하여 문서를 렌더링하고있다. html 타겟 옆에 터미널에서 읽을 수있는 문서를 제공하려면 oder에 man 대상을 사용하고 싶습니다.

스핑크스 문서에서 관련 구성 변수를 찾았지만 설명서 페이지에서 일반적으로 볼 수있는 두 개의 열로 구성된 옵션 목록을 얻는 방법에 대한 힌트 나 예제를 찾지 못했습니다. html및man 타겟이 커버 모범 사례 주위 어떤 가이드 라인은

있습니까?

Answer 1

옵션 목록은 reStructuredText에서 지원됩니다. http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists을 참조하십시오.

이렇게하면 HTML 및 맨 페이지 출력 모두에서 작동합니다. 특별 지시 사항은 없습니다. 다음과 같이 2 열짜리 표를 작성하면됩니다.

-h, --help  Show help message and exit 
--debug   Turn on debug logging 
--verbose  Turn on verbose output