Readthedocs.org: स्फिंक्स ऑटोडॉक के लिए निर्भरता को पूरा करने के लिए `पाइप इंस्टॉल --नो-डिप्स` को अनुमति दें

को निर्मित 20 मार्च 2019 · 3टिप्पणियाँ · स्रोत: readthedocs/readthedocs.org

विवरण

डॉक्स प्रोजेक्ट URL पढ़ें: https://readthedocs.org/projects/xesmf
URL बनाएँ (यदि लागू हो): https://readthedocs.org/projects/xesmf/builds/8484627/
डॉक्स उपयोगकर्ता नाम पढ़ें (यदि लागू हो): zhuangjw

संकट

मैं अपने पायथन पैकेज के लिए एपीआई डॉक्स जेनरेट करने के लिए स्फिंक्स-ऑटोडोक का उपयोग कर रहा हूं।

मूल रूप से मैंने रीडथेडॉक्स पर पूर्ण निर्भरता स्थापित करने के लिए कोंडा का उपयोग किया था, लेकिन इसे बनाने में बहुत समय लगा और कभी-कभी विफल भी हो गया (# 4695)। इसलिए, मैंने शुद्ध pip (https://github.com/JiaweiZhuang/xESMF/commit/53816d397b3c8f27b195132b27dbb41847e34e0f) पर स्विच किया, जिसने निर्माण को बहुत तेज कर दिया। हालांकि, उस स्विच के बाद से, Sphinx-autodoc API दस्तावेज़ जनरेट करने में विफल रहा। मेरा एपीआई पेज लगभग खाली है:

Screen Shot 2019-03-20 at 2 51 31 PM

ऐसा इसलिए है क्योंकि मेरे पैकेज में ही भारी निर्भरता है जिसे pip द्वारा स्थापित नहीं किया जा सकता है। कुछ सी/फोरट्रान एक्सटेंशन conda द्वारा इंस्टॉल किए जाने चाहिए। तो, ऑटोडोक मेरा पैकेज आयात नहीं कर सकता:

WARNING: autodoc: failed to import module 'xesmf.frontend'; the following exception was raised:
No module named 'xesmf'
WARNING: autodoc: failed to import module 'xesmf.backend'; the following exception was raised:
No module named 'xesmf'
...

मेरे द्वारा आजमाए गए तरीके

मैं दो हैक्स का उपयोग करके स्थानीय रूप से पाइप के साथ सही एपीआई दस्तावेज़ उत्पन्न करने में सक्षम हूं:

मेरे पैकेज की स्थापना को pip install --no-deps xesmf द्वारा बाध्य करें।
autodoc_mock_imports = ['numpy', 'xarray', 'scipy', 'ESMF'] में conf.py autodoc_mock_imports = ['numpy', 'xarray', 'scipy', 'ESMF'] जोड़कर निर्भरता का नकली-आयात करें। उनमें से, ईएसएमएफ एक अत्यधिक भारी निर्भरता है जिसे केवल कोंडा द्वारा स्थापित किया जा सकता है (और स्थापित करने में लंबा समय लगता है)।

यहां तक कि autodoc_mock_imports भी, मुझे अभी भी अपने पैकेज xesmf को sphinx-autodoc के लिए डॉकस्ट्रिंग प्रदान करने के लिए पाइप-इंस्टॉल करना होगा। मैंने डॉक्स कॉन्फ़िगरेशन फ़ाइल पढ़ें पढ़ा है लेकिन --no-deps विकल्प निर्दिष्ट करने या कस्टम पाइप कमांड जोड़ने का कोई तरीका नहीं ढूंढ सकता।

अभी, मैं एपीआई दस्तावेज़ों को सही ढंग से ऑनलाइन बनाने के लिए केवल दो अत्यधिक असंतोषजनक समाधानों के बारे में सोच सकता हूं:

पूर्ण निर्भरता स्थापित करने के लिए कोंडा दृष्टिकोण पर वापस लौटें। यह एक बहुत बड़ा ओवरकिल है क्योंकि डॉक्स बनाने के लिए केवल मेरे पैकेज में डॉकस्ट्रिंग की आवश्यकता होती है, न कि उन सी/फोरट्रान एक्सटेंशन की।
या, मेरे पैकेज के setup.py में आवश्यकता को बदलें, ताकि मैं इसे --no-deps विकल्प के बिना पाइप-इंस्टॉल कर सकूं। यह मेरे पैकेज के लिए ही अच्छा नहीं है।

तो मैं अभी भी एक बेहतर समाधान की तलाश में हूं। किसी भी सुझाव की सराहना की जाएगी!

अतिरिक्त जानकारी

यहाँ मेरे लैपटॉप पर सही दस्तावेज़ बनाने के लिए पूर्ण चरण दिए गए हैं:

conda create -n doc python=3.6
conda activate doc
conda install -c conda-forge pandoc
pip install numpydoc ipython nbsphinx sphinx_rtd_theme
pip install --no-deps xesmf
git clone https://github.com/JiaweiZhuang/xesmf
cd xesmf/doc
make html

सही एपीआई पेज इस तरह दिखेगा:
Screen Shot 2019-03-20 at 3 23 15 PM

Support

स्रोत

JiaweiZhuang

👍3

सबसे उपयोगी टिप्पणी

@stsewd सुझाव के लिए धन्यवाद! मैंने setup.py बदलाव किया ताकि:

on_rtd = os.environ.get('READTHEDOCS') == 'True'
if on_rtd:
    INSTALL_REQUIRES = []
else:
    INSTALL_REQUIRES = ['esmpy', 'xarray', 'numpy', 'scipy']

(https://github.com/JiaweiZhuang/xESMF/commit/5ce3364bfbd3081aad848c5cf4ac54a287ca236e)

थोड़ा हैकी लगता है लेकिन समस्या का समाधान करता है। एक बार फिर धन्यवाद।

JiaweiZhuang 21 मार्च 2019

👍3 ❤2

सभी 3 टिप्पणियाँ

मुझे नहीं लगता कि हम पाइप के लिए और विकल्प जोड़ने जा रहे हैं, क्षमा करें। एक समाधान जो मेरे दिमाग में आता है वह है READTHEDOCS env चर का उपयोग करना https://docs.readthedocs.io/en/stable/faq.html#how -do-i-change-behavior-for- अपनी setup.py फ़ाइल में दस्तावेज़ पढ़ें।

stsewd 20 मार्च 2019

और अगर आपको कुछ निर्भरताओं की आवश्यकता है, तो आप केवल अपने दस्तावेज़ों के लिए एक कस्टम आवश्यकता फ़ाइल बना सकते हैं।