如何使用sphinx与烧瓶?

时间:2015-07-23 22:06:27

标签: python flask python-sphinx

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

我用烧瓶包装服务。它可以通过端点

访问
localhost:5000/predict?...

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

localhost:5000/doc

我怎样才能优雅地实现这一目标?

1 个答案:

答案 0 :(得分:0)

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
    )