Bonjour,
Je suis en train de tester un peu sphinx pour documenter un peu de code Python.
J'ai utilisé sphinx-apidoc pour générer les fichiers pour l'ensemble de mon code.
Voilà, cependant, le code HTML des doctests n'est pas lisible.
J'ai un truc comme cela ci-dessous dans le code et dans le HTML les sauts de ligne ne sont pas respectés.
Une idée ?
Merci.
def stat (self):
""" Return a tuple containing the state of each observer.
>>> myObservable = Observable()
# subscribe some inlined functions.
# myObservable[lambda x, y: x * y] would also work here.
>>> myObservable.subscribe(lambda x, y: x * y)
>>> myObservable.subscribe(lambda x, y: float(x) / y)
>>> myObservable.subscribe(lambda x, y: x + y)
>>> myObservable.subscribe(lambda x, y: x - y)
# emit parameters to each observer
>>> myObservable.emit(6, 2)
# get updated values
>>> print myObservable.stat() # returns: (12, 3.0, 8, 4)
(12, 3.0, 8, 4)
"""
return tuple(self.values()
# Peut-être ajouter des directives sphinx ?
Posté par lolop (site web personnel) . Évalué à 2.
Cf doc et exemples sur http://sphinx-doc.org/ext/doctest.html
Votez les 30 juin et 7 juillet, en connaissance de cause. http://www.pointal.net/VotesDeputesRN
[^] # Re: Peut-être ajouter des directives sphinx ?
Posté par sifu . Évalué à 1.
Justement, j'ai désactivé ce module car je ne veux pas qu'il exécute des tests.
Je veux jute qu'il affiche correctement les commentaires présent dans l'entête de mes fonctions (y compris les doctests).
Merci.
# Literal block ?
Posté par Alex G. . Évalué à 2.
Je pense qu'il faut que tu mette tes doc test comme un "literal block" cf http://docutils.sourceforge.net/docs/user/rst/quickref.html#literal-blocks
Donc soit en mettant "Return a tuple containing the state of each observer::" (attention le :: doit coller au mot précédent, comme en anglais) ou juste "::" avant ton code. Enfin ton code doit être indenté.
Suivre le flux des commentaires
Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.