स्फिंक्स-बिल्ड विफल - ऑटोडोक मॉड्यूल आयात / खोज नहीं कर सकता

Question

मैं स्फिंक्स के साथ शुरुआत करने की कोशिश कर रहा हूं और लगता है कि अथक समस्याएं हैं।

कमान: docs/sphinx-quickstart

मैं सभी सवालों के जवाब देता हूं और सब कुछ ठीक चलता है।

कमान: docs/ls

सब कुछ सामान्य लग रहा है। परिणाम:build Makefile source

कमान: sphinx-build -d build/doctrees source build/html

यह काम करने लगता है। मैं index.html फ़ाइल खोलने में सक्षम था और मैं जो चाह रहा हूँ उसका "खोल" देख सकता हूँ।

जब मैं कोशिश करता हूं और अपना वास्तविक स्रोत कोड sourceफ़ोल्डर के रूप में रखता हूं, तो मैं समस्याओं में चला जाता हूं।

कमान: sphinx-build -d build/doctrees ../ys_utils build/html

परिणाम:

Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
No builder selected, using default: html
loading intersphinx inventory from http://docs.python.org/objects.inv...
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
Traceback (most recent call last):                                                                                               
  File "/usr/local/lib/python2.6/dist-packages/Sphinx-1.1.3-py2.6.egg/sphinx/ext/autodoc.py", line 321, in import_object
    __import__(self.modname)
ImportError: No module named ys_utils
Traceback (most recent call last):
  File "/usr/local/lib/python2.6/dist-packages/Sphinx-1.1.3-py2.6.egg/sphinx/ext/autodoc.py", line 321, in import_object
    __import__(self.modname)
ImportError: No module named ys_utils.test_validate_ut
Traceback (most recent call last):
  File "/usr/local/lib/python2.6/dist-packages/Sphinx-1.1.3-py2.6.egg/sphinx/ext/autodoc.py", line 321, in import_object
    __import__(self.modname)
ImportError: No module named ys_utils.git_utils
Traceback (most recent call last):
  File "/usr/local/lib/python2.6/dist-packages/Sphinx-1.1.3-py2.6.egg/sphinx/ext/autodoc.py", line 321, in import_object
    __import__(self.modname)
ImportError: No module named setup.setup

/home/ricomoss/workspace/nextgen/ys_utils/ys_utils.rst:4: WARNING: autodoc can't import/find module 'ys_utils', it reported error: "No module named ys_utils", please check your spelling and sys.path
/home/ricomoss/workspace/nextgen/ys_utils/ys_utils.rst:10: WARNING: autodoc can't import/find module 'ys_utils.test_validate_ut', it reported error: "No module named ys_utils.test_validate_ut", please check your spelling and sys.path
/home/ricomoss/workspace/nextgen/ys_utils/ys_utils.rst:12: WARNING: don't know which module to import for autodocumenting u'UnitTests' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
/home/ricomoss/workspace/nextgen/ys_utils/ys_utils.rst:18: WARNING: autodoc can't import/find module 'ys_utils.git_utils', it reported error: "No module named ys_utils.git_utils", please check your spelling and sys.path
/home/ricomoss/workspace/nextgen/ys_utils/ys_utils.rst:24: WARNING: autodoc can't import/find module 'setup.setup', it reported error: "No module named setup.setup", please check your spelling and sys.path
WARNING: master file /home/ricomoss/workspace/nextgen/ys_utils/index.rst not found
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/ricomoss/workspace/nextgen/ys_utils/ys_utils.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [ 50%] index                                                                                                   
Exception occurred:
  File "/usr/local/lib/python2.6/dist-packages/Sphinx-1.1.3-py2.6.egg/sphinx/environment.py", line 1213, in get_doctree
    f = open(doctree_filename, 'rb')
IOError: [Errno 2] No such file or directory: '/home/ricomoss/workspace/nextgen/docs/build/doctrees/index.doctree'
The full traceback has been saved in /tmp/sphinx-err-jjJ7gM.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
Either send bugs to the mailing list at <http://groups.google.com/group/sphinx-dev/>,
or report them in the tracker at <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!

मैं स्फिंक्स के लिए एक पूर्ण नौसिखिया हूं और इस तरह के प्रलेखन के लिए अपेक्षाकृत नया हूं। किसी को कुछ सुझाव दे सकते हैं?

संपादित करें:

मैं इसे संभालने के लिए एक मेकफाइल का उपयोग करने में सक्षम होना चाहता हूं। अब तक मेरे प्रोजेक्ट में दो फोल्डर हैं।

nextgen/ls

docs ys_utils

मुझे उन सभी मॉड्यूलों के nextgen/docs/Makefileलिए HTML जेनरेट करना होगा जो ys_utilsमेरे पास होने वाले हैं।

Answer 1

ऑटोडोक आपके मॉड्यूल को नहीं ढूंढ सकता है, क्योंकि वे अंदर नहीं हैं sys.path।

आपको अपने मॉड्यूल को अपने में पथ को शामिल करना sys.pathहोगा conf.py। अपने ऊपर conf.py(बस आयात के बाद sys) देखें, एक sys.path.insert()बयान है, जिसे आप अनुकूलित कर सकते हैं।

वैसे: आप Makefileअपने दस्तावेज़ बनाने के लिए स्फिंक्स द्वारा निर्मित का उपयोग कर सकते हैं । बस कॉल करना

make

विकल्प देखने के लिए।

अगर कोशिश करने से पहले कुछ गलत हो गया:

make clean

दौड़ने से पहले make html।

Answer 2

ऐसा लगता है कि os.path.append()लोगों के लिए ठीक काम कर रहा है, लेकिन यदि आप conf.pyटेम्पलेट का पालन करते हैं , तो आप sys.pathउपयोग करने के सामने मॉड्यूल पथ डालेंगे os.path.insert(0, ...), और एक अतिरिक्त जोड़ देंगे.

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

यदि आपके पास sphinxअलग buildऔर sourceनिर्देशिकाओं का उपयोग करने के लिए अपनी परियोजना है , तो उस कॉल को इसके बजाय होना चाहिए:

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

Answer 3

में conf.py

बस अपने प्रोजेक्ट फ़ोल्डर में पथ जोड़ें।

sys.path.append('/home/workspace/myproj/myproj')

Comments

पथ हार्ड-कोडिंग सबसे अच्छी चीज नहीं है जो आप अपने साथ कर सकते हैं conf.py।

— फायरगुरुफिकु

यदि आपके पास एक परियोजना संरचना है /app, जैसे /docs... आप का उपयोग कर सकते हैं sys.path.append(os.path.join(os.path.dirname(__name__), '..'))और फिर .. automodule:: appआपके .rst-file में उपयोग कर सकते हैं ।

— fnkr

Answer 4

अगर

1. मॉड्यूल रूट पथ को सही ढंग से conf.py में सेट किया गया है
2. __init__.py सही ढंग से रखा गया है
3. rst सिंटैक्स सही है

और आपका ऑटोडोक अभी भी मॉड्यूल नहीं ढूंढ सकता है ...

यह हो सकता है क्योंकि उन मॉड्यूल की निर्भरता आपके अजगर पर्यावरण के तहत संतुष्ट नहीं हैं। आप जांचना चाहेंगे कि सभी आयात विवरण मॉड्यूल के भीतर काम कर रहे हैं या नहीं।

Comments

मुझे नहीं लगता कि स्फिंक्स को निर्भरता की आवश्यकता क्यों है, क्या यह डॉकस्ट्रिंग्स के भीतर परीक्षण होने की संभावना के कारण है? क्या इससे बचा जा सकता है (मुझे किसी भी पैकेज की आवश्यकता नहीं है, मैं सिर्फ स्फिंक्स को html में डॉकस्ट्रिंग को पार्स करना चाहता हूं)।

— cglacet

यदि आप इन निर्भरता को आयात नहीं करना चाहते हैं, तो अपनी गोपनीय फ़ाइल में autodoc_mock_imports का उपयोग करें: sphinx-doc.org/en/master/usage/extensions/…

— filip stepniak

Answer 5

मुझे लगता है कि मैंने ऐसा पहली बार किया था जब मैंने एक फाइल को toctree में जोड़ने की कोशिश की थी। मुझे लगता है कि ऐसा इसलिए था क्योंकि मैंने अधिकतम लाइन: फ़ाइल नाम और फ़ाइल नाम के बीच रिक्त लाइन को छोड़ दिया था।

.. Animatrix Concepts documentation master file, created by
   sphinx-quickstart on Thu Mar 22 18:06:15 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Animatrix Concepts documentation!
============================================

Contents:

.. toctree::
   :maxdepth: 2

   stuff


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

ऊपर मेरी index.rst फ़ाइल है। stuff.rst उसी डायरेक्टरी में रहता है जैसे कि।

Comments

यह कहां जाएगा? मेरे पास है index.rstमें /docs/sourceऔर /ys_utils। मैं अनुमान लगा रहा हूं कि यह docsसंस्करण में होना चाहिए ? मैं केवल उस डिफ़ॉल्ट index.rstफ़ाइल का उपयोग कर रहा हूं, जिसके साथ बनाया गया था sphinx-quickstart।

— रिको

-1 ट्रेसबैक के रूप में यह स्पष्ट है कि मॉड्यूल में नहीं हैं sys.path, इसलिए ऑटोडोक उन्हें नहीं मिला। .rstफ़ाइलों पाए जाते हैं।

— bmu

Answer 6

मुझे यह त्रुटि मिली लेकिन यह अन्य उत्तरों में बताए गए कारण से बिल्कुल अलग कारण के कारण था।

मेरा .. automethod:: mymodule.funcनिर्देश वास्तव में होना चाहिए था:

.. automethod:: mymodule::func`

Answer 7

आप उन दस्तावेज़ों को उत्पन्न करने के लिए Pweave और Noweb फॉर्मेटिंग का उपयोग कर सकते हैं , जिनमें कोड का आउटपुट शामिल है। मूल रूप से, आप अपनी rst फ़ाइल लिखते हैं, अजगर कोड के साथ इस तरह चिह्नित चिन्हों में एम्बेडेड है:

<<echo=False>>=
print("some text that will appear in the rst file")
@

और प्वेवे उन चंक्स को निष्पादित करेगा, और उन्हें अपने आउटपुट के साथ एक परिणामी rst फ़ाइल में बदल देगा, जिसे आप तब स्फिंक्स के साथ उपयोग कर सकते हैं। Pweave reST का उदाहरण देखें कि यह कैसा दिखता है।