如何将 sphinx 与烧瓶一起使用？

Question

我项目的文档主要依赖于 sphinx 生成的 autodoc。该项目的目的是提供预测服务。

我用烧瓶包裹服务。并且可以通过端点访问

localhost:5000/predict?...

我想将我的文档也集成到 Flask 中，以便可以通过同一应用程序对象中的另一个端点访问它，例如

localhost:5000/doc

我怎样才能优雅地做到这一点？

Answer 1

Sphinx-doc 生成的文件是静态的，因此您只需静态发送即可。

根据 send_file 文档，它会是这样的：

@app.route('/docs', defaults={'filename': 'index.html'})
@app.route('/docs/<path:filename>')
def documentation(filename):
    return flask.send_from_directory(
        app.config['UPLOAD_FOLDER'],
        filename
    )

如何将 sphinx 与烧瓶一起使用？

How to use sphinx with flask?

python

flask

python-sphinx