Sphinx: Fehler beim Festsetzen des Toctrees

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
Antworten
gardiac2002
User
Beiträge: 5
Registriert: Samstag 7. Juli 2012, 10:36
Wohnort: Wien

Dienstag 30. Oktober 2012, 10:06

Hallo,
ich versuche gerade ein Dokumentationsskript mit Sphinx zu schreiben. Sphinx braucht zur Erstellung von einer HTML Doku restructured Text Dateien, die ich manuell mit sphinx-autogen erstellt habe. Dann habe ich in meinem Workspace sphinx-quickstart ausgeführt und eine index.rst erstellt.

make html funktioniert aber ich erhalte viele Fehlermeldungen - meine Dokumentation ist so gut wie leer und die untergeordneten .rst-Dateien werden nicht gefunden. Anscheinend mache ich etwas bei Angabe der Pfade falsch.
  • Mache ich einen Fehler bei der index.rst oder sieht jemand in meinem Code einen Gedankenfehler?
  • Wie kann ich in Sphinx bestimmen welche Pfade genau durchsucht werden?
Index.rst

Code: Alles auswählen

Meine Dokumentation
====================================
Contents:

.. toctree::
   :maxdepth: 2

.. automodule:: tasks/add_to_config
   :members:

.. automodule:: tasks/build_egg
   :members:  
tasks.rst

Code: Alles auswählen

tasks Package
=============

:mod:`tasks` Package
--------------------

.. automodule:: tasks.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`add_to_config` Module
---------------------------

.. automodule:: tasks.add_to_config
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`build_egg` Module
-----------------------

.. automodule:: tasks.build_egg
    :members:
    :undoc-members:
    :show-inheritance:
Und abschließend ein Teil der Fehlermeldungen von make html:

Code: Alles auswählen

WARNING: invalid signature for automodule (u'tasks/add_to_config')
WARNING: autodoc can't import/find module 'tasks.add_to_config', it reported error: "No module named wl_build.tasks", please check your spelling and sys.path
WARNING: don't know which module to import for autodocumenting u'tasks/add_to_config' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
...
Vielleicht habe ich ja mehr Glück als bei Stackoverflow - da habe ich bisher keine Antwort erhalten. :(
BlackJack

Dienstag 30. Oktober 2012, 10:32

@gardiac2002: In der `index.rst` die Modulnamen sind keine. Das sagt ja auch die erste Warnung. Versuch mal ein ``import tasks/add_to_config`` in Python — das wird Dir auch um die Ohren fliegen. Vergleich das doch mal mit den entsprechenden Direktiven in der ``tasks.rst``, da werden die Module richtig angegeben.
gardiac2002
User
Beiträge: 5
Registriert: Samstag 7. Juli 2012, 10:36
Wohnort: Wien

Freitag 2. November 2012, 11:16

@BlackJack: Vielen Dank - das war gleich ein Treffer :)
Antworten