preguntar acerca de python-sphinx

3
réponses

Ajout d’un renvoi à un sous-titre ou à une ancre dans une autre page

Comment insérer une référence croisée dans une page reST/Sphinx vers un sous-en-tête ou une ancre dans une autre page du même ensemble de documentation? ... …
demandé sur 1970-01-01 00:33:33
2
réponses

Documentation de l’API de service web RESTful avec Sphinx [fermé]

Quelle est la meilleure façon de baliser les méthodes / URL pour un webservice RESTful utilisant ReST / Sphinx? Existe-t-il un domaine par défaut qui convient au marquage des URL avec leurs paramètres possibles, leurs méthodes HTTP, leurs en-têtes et …
demandé sur 1970-01-01 00:33:30
3
réponses

Gras italique dans ReStructuredText

J'écris de la documentation en utilisant le format Rest (REST) pour la génération ultérieure de pages web en utilisant Sphinx, et je ne trouve pas de moyen d'écrire du texte "gras italique". Il y a des marqueurs de la soi-disant 'accent' (italique) …
demandé sur 1970-01-01 00:33:32
1
réponses

comment afficher les attributs d’instance dans sphinx doc?

Est-il un moyen d'afficher automatiquement les variables var1 et var2 et de leurs valeurs d'initialisation dans le sphinx de la documentation? class myClass(): """ Description for class """ def __init__(self, par1, par2): …
demandé sur 1970-01-01 00:33:31
2
réponses

Comment Pouvons-nous intégrer des images dans sphinx docs?

Je suis assez nouveau dans l'utilisation de sphinx, en faisant de la documentation pour la première fois pour le projet python. Comment intégrer l'image par exemple dans la documentation sphinx ? ... …
demandé sur 1970-01-01 00:33:34
3
réponses

Comment aligner à droite le contenu des colonnes dans les tables simples reStructuredText?

J'édite la documentation d'un de mes projets en utilisant Sphinx , qui à son tour utilise reStructuredText comme langage de balisage. J'ai une table simple (par opposition à table de grille ) dans laquelle les rapports de colonne les plus à dro …
demandé sur 1970-01-01 00:33:31
6
réponses

Comment utiliser Python pour générer par programmation une partie de la documentation Sphinx

J'utilise Sphinx pour générer la documentation d'un de mes projets. Dans ce projet, je décris une liste de commandes disponibles dans un fichier yaml qui, une fois chargé, aboutit à un dictionnaire sous la forme {command-name : command-descripti …
demandé sur 1970-01-01 00:33:31
3
réponses

Quelle est la relation entre docutils et Sphinx?

Il semble y avoir une pléthore d'outils de documentation pour Python. Un autre que j'ai rencontré est epydoc. Il semble que Sphinx soit le standard de facto, car il est utilisé pour générer les documents Python officiels. Quelqu'un peut-il trier l'ét …
demandé sur 1970-01-01 00:33:30
4
réponses

Sphinx, reStructuredText afficher/masquer des extraits de code

j'ai documenté un paquet logiciel en utilisant Sphinx et reStructuredText. dans Mes documents, il y a de longs extraits de code. Je veux pouvoir les avoir cachés par défaut, avec un petit bouton "Show / Hide" qui les développerait (Exemple ... …
demandé sur 1970-01-01 00:33:30
6
réponses

Comment construire la documentation sphinx pour le projet django

j'ai un projet django, que j'document à l'aide de repos dans les docstrings de faire ce qui suit: Aide diagloags au sein de l'IDE plus tard pour construire la documentation HTML en utilisant Sphinx ma documentation apparaît correctement dans IDE ( …
demandé sur 1970-01-01 00:33:31