Nhân sư - Mô-đun, lớp và chức năng Python Tài liệu

Question

Tôi đang cố gắng ghi lại dự án nhỏ của mình thông qua nhân sư mà gần đây tôi đang cố gắng làm quen. Tôi đọc một số hướng dẫn và tài liệu hướng dẫn nhân sư nhưng không thể làm được. Thiết lập và cấu hình là ok! chỉ có vấn đề trong việc sử dụng nhân sư theo cách kỹ thuật.

bảng của tôi về nội dung sẽ giống như thế này

--- Overview 

    .....Contents 

----Configuration 

     ....Contents 

---- System Requirements 

     .....Contents 

---- How to use 

     .....Contents 

---- Modules 

     ..... Index 

     ......Display 


----Help 

     ......Content 

Hơn nữa tập trung của tôi là trên Modules với docstrings. Chi tiết về Modules là

Thư mục: - c:/wamp/www/dự án/

  ----- 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 Tài liệu Thư mục: - c:/users/abc/Desktop/tài liệu/doc/

      --- _build 

          --- _static 

          --- _templates 

          --- conf.py 

          --- index.rst 

Tôi đã thêm thư mục Mô-đun vào môi trường hệ thống và đã chỉnh sửa chỉ mục.rst bằng các mã sau chỉ để kiểm tra Bảng nội dung. Nhưng tôi không thể trích xuất trực tiếp docstring

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

Làm thế nào tôi có thể tiếp tục từ đây ...

Hơn nữa, tôi chỉ là một người mới bắt đầu để Sphinx công cụ tài liệu

Tôi cần đề xuất của bạn để đưa các mô-đun của tôi docstring vào trang tài liệu của tôi

Cảm ơn

Answer 1

Để sử dụng mô-đun của bạn docstrings bạn phải sử dụng autodoc extension. Sử dụng "extension" variable trong conf.py của bạn để bật tính năng này.

Answer 2

Florian là chính xác; "tiện ích mở rộng tự động", có liên kết mà anh cung cấp, là những gì bạn đang tìm kiếm. Nếu bạn cần nhiều hơn một giới thiệu về Sphinx, bạn có thể tìm thấy hướng dẫn tôi đã cung cấp tại PyCon 2010 hữu ích - mặc dù bạn chắc chắn sẽ tìm thấy nó rất dài. :-)

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