Sphinx - Python Modules, Classes, and Functions Documentation

Question

I am trying to document my small project through the sphinx, which I recently tried to meet. I read several manuals and documentation on the sphinx, but could not do it. Setup and configurations are in order! just having problems using sphinx in a technical way.

My content table should look like this

--- Overview

    .....Contents

----Configuration

       ....Contents

---- System Requirements

      .....Contents

 ---- How to use 

      .....Contents

 ---- Modules 

      ..... Index

      ......Display


 ----Help

      ......Content

In addition, I focus on Modules with docstrings. Details of modules

Directory: - c: / wamp / www / project /

            ----- 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 Documentation Directory: - c: / users / abc / Desktop / Documentation / doc /

                           --- _build

                           --- _static

                           --- _templates

                           --- conf.py

                           --- index.rst

I added the Modules directory to the system environment and edited index.rst with the following codes to check the contents table. But I could not directly extract the 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
-------

How can I continue here ...

, sphinx

docstring

Answer 1

; "autodoc extension", , , . Sphinx, , PyCon 2010, - , , .: -)

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

Answer 2

docstrings , autodoc. "extension" variable conf.py, .