フラスコに安らかなAPIを文書化するためにSphinxオートフラスコを構成するには？

Question

私はフラスコに安らかなAPIを文書化するために、スフィンクスのオートフラッシュ指令を使いたいフラスコアプリを持っています。

https://pythonhosted.org/sphinxcontrib-httpdomain/#module-sphinxcontrib.autohttp.flask

私はピップを経由してモジュールをインストールしてくれconf.pyとindex.rstを与えるスフィンクス - クイックスタートを実行しました。

私はconf.pyに拡張子を入れて試してみた：ドキュメントごとにindex.rstに

extensions = ['sphinxcontrib.autohttp.flask'] 

とディレクティブ：

.. autoflask:: autoflask_sampleapp:app 
:undos-static: 

しかし、私はアプリを取得することはできません：モジュール（autoflask_sampleapp：app）の部分が正しい。その結果、私がsphinx-buildを実行すると、appかモジュールが見つからないというエラーが出ます。

. 
├── admin 
├── apis 
├── app 
│   ├── static 
│   └── templates 

とアプリケーションのルートディレクトリから、私が言うことができます：

from apis import profile 

私が正しく見つけることindex.rstオートフラスコを設定するにはどうすればよい

マイアプリの木は、このようになります。私のアプリのAPIモジュールを読み込みますか？フラスコアプリでapplication.pyファイル

Answer 1

私のコードの構造は、私はconf.pyで

├── application.py 
├── _build 
│   ├── doctrees 
│   │   ├── environment.pickle 
│   │   └── index.doctree 
│   └── html 
│    ├── genindex.html 
│    ├── http-routingtable.html 
│    ├── index.html 
│    ├── objects.inv 
│    ├── search.html 
│    ├── searchindex.js 
│    ├── _sources 
│    │   └── index.txt 
│    └── _static 
├── conf.py 
├── index.rst 

のrunserver私のサーバーのpython appllication.pyを実行して、あなたは拡張子を含めて、あなたに腹筋パスを含める必要がありますapplication.pyまたはあなたのプロジェクトの他のメインフラスコアプリファイル。

import os 
import sys 
sys.path.insert(0, os.path.abspath('.')) 

# -- General configuration ------------------------------------------------ 

# If your documentation needs a minimal Sphinx version, state it here. 
# 
# needs_sphinx = '1.0' 

# Add any Sphinx extension module names here, as strings. They can be 
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 
# ones. 
extensions = [ 
    'sphinxcontrib.autohttp.flask', 
    'sphinxcontrib.autohttp.flaskqref' 
] 

あなたは青写真を使用することができたら、フラスコのアプリつまり

My documentation! 
======================================= 


.. qrefflask:: application:application 
    :undoc-static: 

======================================= 
Api details! 
======================================= 

.. autoflask:: application:application 
    :undoc-static: 

からの眺め、実行がHTMLを作る前に、あなたは、Pythonのsysパスのsysを経由してあなたに、ルートアプリケーションフォルダABSパスを追加する必要があります。 path.insert（0、os.path.abspath（ '/ home/myproject /'））、/ home/myprojectフォルダにソースコードがあります。