Sphinx - Python modules, classes and functions documentation

Posted by user343934 on Stack Overflow See other posts from Stack Overflow or by user343934
Published on 2010-06-06T14:23:06Z Indexed on 2010/06/06 14:32 UTC
Read the original article Hit count: 400

Filed under:
|
|

Hi everyone,

I am trying to document my small project through sphinx which im recently trying to get familiar with. I read some tutorials and sphinx documentation but couldn't make it. Setup and configurations are ok! just have problems in using sphinx in a technical way.

My table of content should look like this

--- Overview

     .....Contents

----Configuration

       ....Contents

---- System Requirements

      .....Contents

---- How to use

      .....Contents

---- Modules

      ..... Index

      ......Display

----Help

      ......Content

Moreover my focus is on Modules with docstrings. Details of Modules are

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 have added Modules directory to the system environment and edited index.rst with following codes just to test Table of content. But i couldn't extract docstring directly

Index.rst>>>>>>>

T-Alignment Documentation


The documentation covers general overview

of the application covering functionalities and requirements in details.

To know how to use application its better to go through the documentation.

.. _overview:

Overview

.. _System Requirement:

System Requirement

Seq-alignment tools can be used in varied systems base on whether all intermediary applications are available

or not like in Windows, Mac, Linux and UNIX. But, it has been tested on the Windows working under a beta version.

  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 from here...

Moreover, i am just a beginner to sphinx documentation tool

I need your suggestions to brings my modules docstring to my documentation page

Thanks

© Stack Overflow or respective owner

Related posts about python

Related posts about documentation