Sphinxでマニュアルページとしてレンダリングされる再構成されたテキストのオプションリストをどのようにフォーマットしますか？

Question

私はコマンドラインツールのドキュメントを再構成されたテキストとして書く予定です。私はSphinxを使ってドキュメントをレンダリングしています。 htmlターゲットの横に、端末で読み取ることができるドキュメントを提供するために、manターゲットをoderで使用したいと考えています。

Sphinxのマニュアルで関連する設定変数が見つかったにもかかわらず、マニュアルページで2列テーブルとしてよく見られるようなオプションのリストを得るために、マニュアルソースをどのようにフォーマットするのかのヒントや例は見当たりませんでした。

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