Sphinx - Modules, classes et fonctions Python Documentation

Question

J'essaie de documenter mon petit projet par le biais de sphinx que j'ai récemment essayé de familiariser avec. J'ai lu des tutoriels et de la documentation sphinx mais je n'ai pas pu le faire. L'installation et les configurations sont ok! J'ai juste des problèmes pour utiliser le sphinx d'une manière technique.

Ma table de contenu devrait ressembler à ceci

--- Overview 

    .....Contents 

----Configuration 

     ....Contents 

---- System Requirements 

     .....Contents 

---- How to use 

     .....Contents 

---- Modules 

     ..... Index 

     ......Display 


----Help 

     ......Content 

De plus je me concentre sur les modules avec docstrings. Détails des modules sont

Répertoire: - c:/wamp/www/projet/

  ----- 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:/utilisateurs/abc/Desktop/Documentation/doc/

      --- _build 

          --- _static 

          --- _templates 

          --- conf.py 

          --- index.rst 

J'ai ajouté le répertoire Modules à l'environnement système et édité index.rst avec les codes suivants juste pour tester la table des matières. Mais je ne pouvais pas extraire docstring directement

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

Comment puis-je continuer à partir d'ici ...

De plus, je suis un débutant à l'outil de documentation sphinx

J'ai besoin de vos suggestions apporte mes modules docstring sur ma page de documentation

Merci

Answer 1

pour utiliser votre module de docstrings vous devez utiliser le autodoc extension. Utilisez le "extension" variable dans votre conf.py pour l'activer.

Answer 2

Florian a exactement raison; l'extension "autodoc", dont il fournit le lien, est ce que vous cherchez. Si vous avez besoin de plus d'une introduction à Sphinx, vous pourriez trouver le tutoriel que j'ai donné à PyCon 2010 utile - bien que vous le trouverez sans doute aussi très long. :-)

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