我正在开发基于狮身人面像的协作写作工具。用户访问Web应用程序(在python / Flask中开发),以sphinx编写一本书并将其编译为pdf。
我了解到,为了从python中编译sphinx文档,我应该使用
import sphinx result = sphinx.build_main(['-c', 'path/to/conf', 'path/to/source/', 'path/to/out'])
到现在为止还挺好。
现在,我的用户希望该应用向他们显示他们的语法错误。但是输出(result在上面的示例中)仅提供了退出代码。
result
那么,如何从构建过程中获取警告列表?
也许我太有野心了,但是由于sphinx是python工具,因此我期望该工具具有一个不错的pythonic接口。例如,的输出sphinx.build_main可能是一个非常丰富的对象,带有警告,行号…
sphinx.build_main
与此相关的是,该方法的参数sphinx.build_main看起来就像是命令行界面的包装。
sphinx.build_main()调用sphinx.cmdline.main(),依次创建一个sphinx.application.Sphinx对象。您可以直接创建这样的对象(而不是“在python中进行系统调用”)。使用这样的东西:
sphinx.build_main()
sphinx.cmdline.main()
sphinx.application.Sphinx
import os from sphinx.application import Sphinx # Main arguments srcdir = "/path/to/source" confdir = srcdir builddir = os.path.join(srcdir, "_build") doctreedir = os.path.join(builddir, "doctrees") builder = "html" # Write warning messages to a file (instead of stderr) warning = open("/path/to/warnings.txt", "w") # Create the Sphinx application object app = Sphinx(srcdir, confdir, builddir, doctreedir, builder, warning=warning) # Run the build app.build()