[python-users] Sphinx

[Andi Albrecht]

2010/5/4 Jan Ulrich Hasecke <juhasecke at googlemail.com>

> Hallo Andi,
>
> ich hoffe, ich nerve noch nicht zu sehr:
>
> Nächste Frage
>
> Nehmen wir an ich hab:
>
> myprojekt/
> myprojekt/test.py
> myprojekct/docs
>
> und in docs die Sphinx-Doku.
>
> index.rst:
>
> .. automodule:: test
>
> .. autofunction:: test.bar()
>
>
> Was muss ich wo eintragen, damit ich über autodoc die docstrings aus
> test.py einbinden kann?
>
> Ich kriege immer den Fehler:
>
> /Users/Shared/Code/sphinxtest/docs/index.rst:8: (WARNING/2) autodoc can't
> import/find function 'test.bar', it reported error: "bar", please check your
> spelling and sys.path
>

Schau mal oben in der conf.py - da gibt es bereits eine auskommentierte
Zeile, die den Python-Path korrigiert; auch mit einem Hinweis auf die
autodoc-Erweiterung. Da dein Modul "test" heißt, empfiehlt es sich u.U.
nicht sys.path.append, wie in der auskommentierten Zeile vorgeschlagen, zu
verwenden, sondern den Pfad zu deiner test.py etwas weiter vorne in sys.path
einzufügen. Zumindest in meinem Setup ist die Chance ziemlich groß,
irgendeine andere test.py zu erwischen :)

Bei autofunction sollte es auch ausreichen, den Funktionsnamen ohne Klammer
zu schreiben. Alternativ kannst du in diesem Fall autofunction sogar ganz
weglassen und

.. automodule:: test
   :members:

verwenden.

andi


>
> juh
> ________________________________________
> Diese Mail erhalten Sie ueber die Mailingliste Python-users der
> Universitaet zu Koeln
> Python-users at uni-koeln.de
> https://lists.uni-koeln.de/mailman/listinfo/python-users
>
>
-------------- nächster Teil --------------
Ein Dateianhang mit HTML-Daten wurde abgetrennt...
URL: <http://lists.uni-koeln.de/pipermail/python-users/attachments/20100504/5fadc89f/attachment.html>