web-dev-qa-db-fra.com

sphinx-build fail - autodoc ne peut pas importer / trouver le module

J'essaie de démarrer avec Sphinx et semble avoir des problèmes incessants.

Commande: docs/sphinx-quickstart

Je réponds à toutes les questions et tout fonctionne bien.

Commande: docs/ls

Tout a l'air normal. Résultat: build Makefile source

Commande: sphinx-build -d build/doctrees source build/html

Cela semble fonctionner. J'ai pu ouvrir le fichier index.html et voir un "shell" de ce que je veux.

Lorsque j'essaie de placer mon code source actuel dans le dossier source, je rencontre des problèmes.

Commande: sphinx-build -d build/doctrees ../ys_utils build/html

Résultat:

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!

Je suis un débutant au Sphinx et relativement nouveau à ce type de documentation. Quelqu'un peut-il offrir des suggestions?

Modifier:

J'aimerais pouvoir utiliser un Makefile pour gérer cela. A partir de maintenant, j'ai deux dossiers dans mon projet.

nextgen/ls

docs ys_utils

J'ai besoin de nextgen/docs/Makefile pour générer le code HTML pour ys_utils et tous les autres modules que je vais avoir.

pythondocumentationpython-sphinx
78
Rico

Autodoc ne peut pas trouver vos modules, car ils ne sont pas dans sys.path.

Vous devez inclure le chemin de vos modules dans le sys.path De votre conf.py. Regardez en haut de votre conf.py (Juste après l'importation de sys), il existe une instruction sys.path.insert() que vous pouvez adapter.

Au fait: vous pouvez utiliser le Makefile créé par Sphinx pour créer votre documentation. Il suffit d'appeler

make

pour voir les options.

Si quelque chose s'est mal passé avant d'essayer:

make clean

avant d'exécuter make html.

77
bmu

dans conf.py

ajoutez simplement le chemin dans votre dossier de projet.

sys.path.append('/home/workspace/myproj/myproj')
30
Pravitha V

Il semble que os.path.append() fonctionne correctement pour les utilisateurs, mais si vous suivez le modèle conf.py, Vous insérerez le chemin du module devant sys.path À l'aide de os.path.insert(0, ...), et ajoutez simplement un . supplémentaire

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

Si vous avez configuré votre projet sphinx pour qu'il utilise des répertoires distincts build et source, cet appel devrait plutôt être:

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

Je pense que je l'ai fait la première fois que j'ai essayé d'ajouter un fichier à toctree. Je pense que c’est parce que j’ai omis la ligne vide entre la ligne: maxdepth et le nom du fichier.

.. 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`

Ci-dessus, mon fichier index.rst. stuff.rst réside dans le même répertoire que celui-ci.

1
John Gaines Jr.

J'ai eu la même erreur mais elle était due à une raison complètement différente de celle expliquée dans les autres réponses.

Ma .. automethod:: mymodule.func directive aurait dû être:

.. automethod:: mymodule::func`
0
juniper-

Vous pouvez utiliser le formatage Pweave et noweb pour générer les premiers documents qui incluent la sortie du code incorporé dans ceux-ci. Fondamentalement, vous écrivez votre premier fichier avec python incorporé dans des morceaux marqués comme ceci:

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

et Pweave exécutera ces morceaux et les remplacera par leur sortie dans un premier fichier résultant, que vous pourrez ensuite utiliser avec sphinx. Voir le exemple de Pweave reST pour plus de détails sur son apparence.

0
naught101