Sphinx - Python modülleri, sınıfları ve işlevleri Dökümantasyon

Question

Küçük projemi, yakın zamanda tanımaya çalışan bir sphinx aracılığıyla belgelemeye çalışıyorum. Bazı öğreticiler ve sfenks belgeleri okudum ama yapamadım. Kurulum ve yapılandırmalar tamam! Sfenks kullanmada teknik bir sorun var. içerik

Benim tablo bu

--- Overview 

    .....Contents 

----Configuration 

     ....Contents 

---- System Requirements 

     .....Contents 

---- How to use 

     .....Contents 

---- Modules 

     ..... Index 

     ......Display 


----Help 

     ......Content 

gibi Dahası benim odak Docstringler ile Modülleri üzerindedir görünmelidir. Modül detayları olan

Dizin: - c:/wamp/www/proje/

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

My Belgeler Dizini: - c:/kullanıcılar/abc/Masaüstü/Belgeler/doc/

      --- _build 

          --- _static 

          --- _templates 

          --- conf.py 

          --- index.rst 

Sistem ortamına Modüller dizini ekledim ve aşağıdaki kodları kullanarak yalnızca İçindekiler Tablosunu test etmek için index.rst düzenledim. Ama ben ben önerilerinizi ihtiyaç dokümantasyon aracını

sphinx için sadece bir acemi değilim, Ayrıca ...

i buradan devam edebilir nasıl doğrudan

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

docstring'ini çıkaramamıştır benim modülleri benim dokümantasyon sayfasına modül kullanmasıyla

Teşekkür

Answer 1

docstringe getiriyor docstrings kullanmanız gereken autodoc extension. Bunu etkinleştirmek için conf.py'ınızda "extension" variable kullanın.

Answer 2

Florian tam olarak doğru; linki verdiği "autodoc uzantısı", aradığınız şeydir. Eğer Sphinx'e daha fazla giriş yapmanız gerekiyorsa, PyCon 2010'da verdiğim eğitici bilgiyi faydalı bulabilirsin - şüphesiz çok uzun süreler bulabilirsin. onlar Markdown ayrıştırıcı tarafından bozulan alamadım böylece :-)

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