Question

我想使用sphinx文档生成器创建一个站点。但我的机器是窗户。我找不到足够的资源用于Windows。如果有人可以建议我在Windows中实现sphinx的方法将是一个很大的帮助。

感谢。

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)

如何在Windows中使用sphinx文档生成器？

1 个答案: