2012-07-06 32 views
3

我有一個用Python編寫的命令行程序。我想用Sphinx生成手冊頁。如何生成多個手冊頁?

我想通過命令有一個頁面,如:

man myprog foo - >重定向到foo命令的手冊頁。

man myprog foo2 - >重定向到foo2命令的手冊頁。

問題是獅身人面像所有手冊頁的聚集產生唯一一個手冊頁。

我如何獲得預期的結果?

回答

0

鑑於結構

docs/ 
    docs/source 
    docs/source/conf.py 
    docs/source/manable1/includable.rst 
    docs/source/index.rst 

然後,如果你在文檔鍵入

sphinx-build -b man -c source source/manable1/ man/other_man 

可以自動化,通過任一修補生成文件或在bash一個一個襯裏

for i in source/man*; do 
      sphinx-build -b man -c source $i man/$(basename $i); 
    done 

(未經測試但應該接近)

提防包括路徑,親屬,交叉引用....

這可能會限制你可以在Rst的做

+0

謝謝您的回答。我不明白man/other_man的說法。這是什麼 ? – 2012-07-06 12:39:48

+0

只是一種使用每個獨立手冊來構建目錄的方法。該結構將更加人/子主題,其中,子主題處理給定主題的所有相關文件。 – user1458574 2012-09-10 15:05:32