Sphinx ne trouve pas les paquets Python lors de l'utilisation de autodoc
Je suis en train de créer de la documentation pour le test Python projet avant de le faire pour le projet réel.
Mon système : Win7 64 bits, python 2.7.5 64 bits.
Mon nom de projet est testDoc. Il comprend python emballage, nommé t, qui comprend 2 modules t1 et t2 et __init__.py
.
__init__.py
contient:
import t1
import t2
t1.py contient:
'''
Created on 27 2013
@author:
'''
class MyClass(object):
'''
Hi
'''
def __init__(self,selfparams):
'''
Constructor
'''
pass
Pour créer des docs que j'ai exécuter en ligne de commande dans testDoc:
sphinx-apidoc -A "me" -F -o docs .
Sphinx crée beaucoup de fichiers et c'est ok selon les Sphinx docs.
Ensuite, conf.py est modifié
sys.path.insert(0, os.path.abspath(absolute path to testDoc))
- Je entrer docs dossier et le type
make html
et d'obtenir les éléments suivants erronée de sortie:
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 2 source files that are out of date
updating environment: 2 added, 0 changed, 0 removed
reading sources... [ 50%] index
reading sources... [100%] t
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.__init__
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.t1
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.t2
...testDoc\t\docs\t.rst:7: WARNING: a
autodoc can't import/find module 't.__init__', it reported error: "No module name
d t.__init__", please check your spelling and sys.path
...testDoc\t\docs\t.rst:15: WARNING:
autodoc can't import/find module 't.t1', it reported error: "No module named t.t
1", please check your spelling and sys.path
t...testDoc\t\docs\t.rst:23: WARNING:
autodoc can't import/find module 't.t2', it reported error: "No module named t.t
2", please check your spelling and sys.path
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 50%] index
writing output... [100%] t
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.
Build finished. The HTML pages are in _build/html.
Quel est le problème?
Merci.
Ma conjecture est qu'il ya quelque chose de mal avec
Merci. Cependant, le même problème se produit.
absolute path to testDoc
. Ne pouvez-vous pas utiliser os.path.abspath("..")
?Merci. Cependant, le même problème se produit.
OriginalL'auteur user1264304 | 2013-07-28
Vous devez vous connecter pour publier un commentaire.
Je ne sais pas ce que le "chemin d'accès absolu à testDoc", mais à partir du Sphinx de sortie, je peux voir que le testDoc structure de répertoire est
testDoc/t/docs
. Ledocs
répertoire est où conf.py est.Pour le module de recherche de chemin pour être mis en place correctement, vous devez aller à deux niveaux de conf.py:
Je l'ai fait, en ajoutant le chemin de faire les modules, mais encore, il compile et pas de modules montrer ! Toutes les pensées ?
Il est difficile de trouver une bonne suggestion. Chaque projet est différent et je ne sais rien à propos de la vôtre.
pas de soucis. viens de trouver le problème. Le tutoriel que j'utilisais n'a jamais mentionné qu'il devrait être docstrings sur les classes et les modules. Merci pour votre sollicitude !
OriginalL'auteur mzjn