Sphinx - Módulos, clases y funciones de Python Documentación

Question

Estoy tratando de documentar mi pequeño proyecto a través de sphinx con el que recientemente estoy tratando de familiarizarme. Leí algunos tutoriales y la documentación de esfinge pero no pude hacerlo. La configuración y las configuraciones están bien! solo tiene problemas para usar esfinge de manera técnica.

Mi tabla de contenido debe tener este aspecto

--- Overview 

    .....Contents 

----Configuration 

     ....Contents 

---- System Requirements 

     .....Contents 

---- How to use 

     .....Contents 

---- Modules 

     ..... Index 

     ......Display 


----Help 

     ......Content 

Además mi atención se centra en los módulos con cadenas de documentación. Los detalles de los módulos son

Directorio: - c:/wamp/www/proyecto/

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

Mi Directorio Documentación: - c:/usuarios/abc/Escritorio/Documentación/doc/

      --- _build 

          --- _static 

          --- _templates 

          --- conf.py 

          --- index.rst 

He agregado el directorio Módulos al entorno del sistema y he editado index.rst con los siguientes códigos solo para probar la Tabla de contenido. Pero no fue posible extraer el docstring directamente

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

¿Cómo puedo continuar a partir de aquí ...

Por otra parte, soy un principiante en Sphinx instrumento de documentación

Necesito sus sugerencias a trae mis módulos docstring a mi página de documentación

Gracias

Answer 1

para utilizar su módulo de docstrings tienes que usar el autodoc extension. Use el "extension" variable en su conf.py para habilitarlo.

Answer 2

Florian tiene exactamente razón; la "extensión de autodoc", cuyo enlace proporciona, es lo que está buscando. Si necesita más una introducción a Sphinx, puede que le resulte útil el tutorial que di en PyCon 2010, aunque sin duda también lo encontrará muy extenso. :-)

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