Sphinx otomatik şişeyi flask-restful API'sini belgelemek için nasıl yapılandırılır?

Question

Bir şişeye yatkın API'yi belgelemek için Sphinx'in otoflask yönergesini kullanmak istediğim bir flask uygulaması var.

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

ben pip aracılığıyla modülü yüklü ve bana bir conf.py verir ve index.rst hangi sfenks-quickstart çalıştırmak.

Ben conf.py içine uzantısı koyarak denedim: belgelendirmesi olarak index.rst içine

extensions = ['sphinxcontrib.autohttp.flask'] 

ve direktif:

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

Ama app alamayan : modül (autoflask_sampleapp: app) kısmı doğru. Sonuç olarak, sphinx-build çalıştırdığımda, uygulama ya da modül bulunamayan bir hata alıyorum.

Uygulamam ağaçları

şuna benzer:

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

ve uygulamanın kök dizininde

söyleyebileceğim:

from apis import profile 

nasıl doğru bulmak index.rst otomatik şişesi yapılandırabilirim Uygulamamın API modüllerini yükle

Answer 1

şişesi uygulaması ile application.py dosya, sana uzantıları içermelidir conf.py olarak benim sunucu piton appllication.py runserver

├── 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 

çalıştırmak ve application.py için abs yolu dahil Kodum yapısı, veya projenizdeki herhangi bir ana cep telefonu uygulaması dosyası. Eğer planları, yayınlanmadan önce şişe app Bir başka deyişle

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


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

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

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

görünümlerinden html yapmak kullanabilirsiniz sonra

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' 
] 

, sen piton sys yolu sys ile size kök uygulama klasörünü abs yolunu eklemek gerekir. path.insert (0, os.path.abspath ('/ home/myproject /')), burada kaynak kodunuzla/home/myproject klasörü.