फ्लास्क-आरामपूर्ण एपीआई दस्तावेज करने के लिए स्फिंक्स ऑटो फ्लास्क को कैसे कॉन्फ़िगर करें?

Question

मेरे पास एक फ्लास्क ऐप है जो मैं फ्लास्क-रेस्टफुल एपीआई दस्तावेज करने के लिए स्फिंक्स के ऑटोफ्लास्क निर्देश का उपयोग करना चाहता हूं।

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: ऐप) भाग सही है। नतीजतन, जब मैं स्फिंक्स-बिल्ड चलाता हूं तो मुझे एक त्रुटि मिलती है कि या तो ऐप या मॉड्यूल नहीं मिला है।

मेरा ऐप पेड़ इस तरह दिखता है:

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

और एप्लिकेशन का रूट निर्देशिका से, मैं कह सकता हूँ:

from apis import profile 

मैं कैसे index.rst में ऑटो कुप्पी कॉन्फ़िगर सही ढंग से पता लगाने के लिए करते हैं और मेरे ऐप के एपीआई मॉड्यूल लोड करें?

Answer 1

मेरे कोड संरचना, जहां कुप्पी अनुप्रयोग के साथ application.py फ़ाइल, मैं अपने सर्वर अजगर 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 

चलाने conf.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: 

दूसरे शब्दों में से देखा गया, चलने से पहले एचटीएमएल बनाने का उपयोग कर सकते के बाद, आप पेट पथ आप के लिए रूट आवेदन फ़ोल्डर अजगर sys पथ sys के माध्यम से जोड़ना चाहिए। path.insert (0, os.path.abspath ('/ home/myproject /')), जहां आपके स्रोत कोड के साथ/home/myproject फ़ोल्डर।