Sphinx - Python Module, Klassen und Funktionen Dokumentation

Question

Ich versuche mein kleines Projekt durch Sphinx zu dokumentieren, mit dem ich mich in letzter Zeit vertraut machen möchte. Ich habe ein paar Tutorials und eine Sphinx-Dokumentation gelesen, konnte es aber nicht schaffen. Setup und Konfigurationen sind in Ordnung! habe nur Probleme bei der technischen Verwendung von sphinx.

Mein Inhaltsverzeichnis wie dies Außerdem

--- Overview 

    .....Contents 

----Configuration 

     ....Contents 

---- System Requirements 

     .....Contents 

---- How to use 

     .....Contents 

---- Modules 

     ..... Index 

     ......Display 


----Help 

     ......Content 

aussehen soll mein Fokus liegt auf Module mit Docstrings. Details der Module sind

Verzeichnis: - c:/wamp/www/Projekt/

  ----- Index.py 

         >> Class HtmlTemplate: 

           .... def header(): 

           .... def body(): 

           .... def form(): 

           .... def header(): 

           .... __init_main: ##inline function 

      ----- display.py 

         >> Class MainDisplay: 

           .... def execute(): 

           .... def display(): 

           .... def tree(): 

           .... __init_main: ##inline function 

Mein Dokumentationsverzeichnis: - c:/users/abc/Desktop/Dokumentation/doc/

      --- _build 

          --- _static 

          --- _templates 

          --- conf.py 

          --- index.rst 

Ich habe Module-Verzeichnis der Systemumgebung hinzugefügt und index.rst mit folgenden Codes nur zum Testen des Inhaltsverzeichnisses bearbeitet. Aber ich konnte nicht extrahieren docstring direkt

Index.rst>>>>>>> 


T-Alignment Documentation 
************************* 

.. _overview: 

Overview 
-------- 

.. _System Requirement: 

System Requirement 
------------------ 

1. System 

2. Applications 

3. Server 

.. _Configuration:: 

Configuration 
------------- 

Basic steps in configuration involves in following categories 

1. Environment variables 

2. Apache setting 

.. _Modules:: 

Modules 
------- 

Wie kann ich von hier aus weiter ...

Außerdem, ich bin nur ein Anfänger Dokumentations Sphinx

Ich brauche Ihre Vorschläge bringe meine Module zu meiner Dokumentation Seite

Dank

Answer 1

um Ihren Moduls verwenden Docstring Docstrings müssen Sie die autodoc extension verwenden. Verwenden Sie die "extension" variable in Ihrem conf.py, um es zu aktivieren.

Answer 2

Florian ist genau richtig; die "autodoc extension", deren link er anbietet, ist genau das wonach sie suchen. Wenn Sie eine Einführung in Sphinx brauchen, ist das Tutorial, das ich Ihnen auf der PyCon 2010 gegeben habe, hilfreich - obwohl Sie es sicherlich auch sehr lange finden werden. :-)

http://pycon.blip.tv/file/3359587/