如何在windows中使用sphinx文件生成器？

Question

我想用獅身人面像文件生成器做一個網站。但我的機器是windows。我無法找到足夠的資源用於Windows。如果任何人都可以建議我在窗口中實現獅身人面像的方法將是一個很大的幫助。

謝謝。

Answer 1

Sphinx在Windows上工作得很好。要開始，請轉至Quickstart教程並按照說明進行操作。我要補充的一件事是確保你回答「y」的問題，詢問你是否要分開構建和源文件夾。這會讓事情變得更簡單。

如果你想使用apidoc（我認爲你可以），那麼可以使用Python安裝的Scripts文件夾中的命令行工具。或者你可以寫你自己的腳本。下面是一個我寫的讓.rst文件，對於一些目標模塊：

files = [u'C:\\Work\\Scripts\\Grapher\\both_pyplot.py', 
     u'C:\\Work\\Scripts\\Grapher\\colors_pyplot.py', 
     u'C:\\Work\\Scripts\\Grapher\\dataEditor.pyw', 
     u'C:\\Work\\Scripts\\Grapher\\grapher.pyw'] 

for d in ('pyfiles', 'rst_temp'): 
    try: 
     shutil.rmtree(d) 
    except WindowsError: 
     pass 
    os.mkdir(d) 

#copy, rename .pyw files to .py so sphinx will pick them up 
for fn in files: 
    fn2 = fn 
    if fn.lower().endswith('.pyw'): 
     fn2 = fn[:-1] 
    shutil.copy2(fn, os.path.join('pyfiles', os.path.basename(fn2))) 

#now send to apidoc 
lst = [fn, '-o', 'rst_temp', 'pyfiles'] 
from sphinx.apidoc import main 
main(lst) 


msg = ('Now copy the rst files you want documentation for from the ' 
     '"rst_temp" dir to the the "source" dir, edit the index.html file ' 
     'in the "source" dir, and run builder.py') 
print msg 

的apidoc擴展不承認.pyw文件，所以此腳本複製目標模塊到一個臨時位置，並帶有.py擴展其重命名所以apidoc可以使用它們。

要構建您的項目，您可以在項目文件夾（在快速啓動運行時創建）中運行make.bat文件，或者您可以編寫自己的腳本。這裏是一個示例（builder.py）：

import sys, os 
fn = __file__ 

sys.path.append(os.path.normpath('C:\\Work\\Scripts\\Grapher')) 

lst = [fn, '-b', 'html', 'source', 'build'] 

from sphinx import main 
main(lst)