sphinx, autosummary (résolu)

sphinx, autosummary (résolu) - Python - Programmation

Marsh Posté le 09-06-2012 à 15:24:14    

Bonjour à tous [Sphinx 1.1.3, Python 3.2]
je n'arrive pas à comprendre le fonctionnement d'autosummary avec toctree. D'après la documentation (*) les lignes suivantes :

.. autosummary::
   :toctree: DIRNAME
 
    sphinx.environment.BuildEnvironment
   sphinx.util.relative_uri


devraient dire à Sphinx que "(some) stub pages should be generated for the entries listed in this directive". Je devrais donc récupérer un lien vers un fichier décrivant sphinx.environment.BuildEnvironment, et un autre lien vers un fichier décrivant sphinx.util.relative_uri.  
Or quand j'exécute ce code, j'ai le message d'erreur suivant : "WARNING : toctree references unknown document 'sphinx.util.relative_uri". Ce message indique que autosummary ne cherche pas à créer des pages associées à sphinx.util.relative_uri; au contraire, il cherche le fichier .rst portant le nom de sphinx.util.relative_uri. Par contre je suis sûr qu'il lit correctement les données associées aux fonctions sphinx.util.* puisqu'il affiche dans un tableau la docstring correspondante; simplement, je n'ai pas de lien vers un fichier associé à chaque fonction.
 
Est-ce moi qui comprend mal la doc' ?
 
Merci de m'aider !
 
(*) http://sphinx.pocoo.org/ext/autosu [...] utosummary

Message cité 1 fois
Message édité par suizokukan le 22-06-2012 à 11:51:50

---------------
rule #1 : trust the python
Reply

Marsh Posté le 09-06-2012 à 15:24:14   

Reply

Marsh Posté le 22-06-2012 à 11:19:34    

suizokukan a écrit :

Est-ce moi qui comprend mal la doc' ?


Oui. Autosummary crée un résumé de docs existantes, ça génère donc une grosse table liant vers la vraie documentation. Mais il faut cette vraie documentation.
 
La dite vraie documentation peut être soit créée intégralement à la main, être une conséquence d'autodoc ou être généré à partir de tes stubs autosummary.
 
Ce dernier choix est probablement ce à quoi tu t'attendais. Ce n'est pas le comportement par défaut, mais ça peut être activé via autosummary_generate (ou en faisant tourner le script lié au dessus)


---------------
Stick a parrot in a Call of Duty lobby, and you're gonna get a racist parrot. — Cody
Reply

Marsh Posté le 22-06-2012 à 11:51:22    

Merci à Masklinn pour ces renseignements.


Message édité par suizokukan le 22-06-2012 à 16:06:18

---------------
rule #1 : trust the python
Reply

Sujets relatifs:

Leave a Replay

Make sure you enter the(*)required information where indicate.HTML code is not allowed