formelsammlung.flask_sphinx_docs module¶
-
class
formelsammlung.flask_sphinx_docs.
SphinxDocServer
(app=None, **kwargs)[source]¶ Bases:
object
Serve your sphinx docs under /docs/ on your own flask app.
You can invoke it in your app factory:
sds = SphinxDocServer() def create_app(): app = Flask(__name__) sds.init_app(app) return app
or you can include the plugin directly without setting a
doc_dir
:app = Flask(__name__) SphinxDocServer(app)
or with setting a
doc_dir
:app = Flask(__name__) SphinxDocServer(app, doc_dir="../../docs/build/html")