12

私はPythonCLIツールを開発しています( python2.6ではoptparseを使用していますが、すぐにpython2.7に切り替えることを望んでいます)。manページを作成しようとしています。私は次の方法で動的なマニュアルページを生成した経験があります。

  • ポッド形式の文字列を作成してファイルに書き込む専用のメソッドを作成する
  • pod2manコマンドを実行して、 manコマンドに渡されるgroff形式のデータを生成します

また、manページと同じ内容のwikiページを生成したいと思います(podを使用すると、 pod2htmlを介してhtmlを生成でき、おそらくhtmlはwiki形式に簡単に変換できます)。これを行う方法について誰かがより良いアイデア/フローを持っていますか?

私が興味深いと思ったのは、このリンクです。optparseとdistutilsを使用したマニュアルページの作成

4

3 に答える 3

14

Python でドキュメントを生成する通常の方法は、Sphinxを使用することです。たとえば、これは公式の Python ドキュメントで使用されているものです。Sphinx ドキュメント プロジェクトをセットアップしたら ( このチュートリアルを参照)、Sphinx ドキュメント ファイルから man ページを生成できますmake man。また、適切な出力を生成するために構成を変更する必要があります。conf.py

(Sphinx は Python でドキュメントを作成するための通常のツールですが、man ページを生成するための通常のツールであるという意味ではありません。必要なものを使用してください!)

于 2011-08-24T17:16:08.827 に答える
3

使用している場合は、 click-manclickを使用できます。クリック アプリケーションから man ページを生成できます。

于 2016-10-06T16:48:58.043 に答える