2017-07-20 2 views
-1

Nous avons un ensemble de modules Ansible sur GitHub (https://github.com/zhmcclient/zhmc-ansible-modules) et pouvons générer une documentation HTML à partir de Sphinx. Toutefois, le processus de génération inclut une étape où un outil documentationgenerator d'Ansible est exécuté pour générer des fichiers .rst à partir de la source du module Python.Une documentation sur le module RTD?

Nous avons mis en place un projet RTD pour cela (http://zhmc-ansible-modules.readthedocs.io/), mais cette étape supplémentaire n'est pas exécutée ici, bien sûr.

-> Comment pouvons-nous obtenir cette étape supplémentaire dans le processus de construction qui fonctionne sur RTD?

Répondre

1

RTD ne prend pas en charge les étapes intermédiaires dans son processus de construction. Vous devez fournir des fichiers source dans votre référentiel prêts à être rendus. Voir RTD Build Process.

+0

Merci pour la réponse. J'avais peur que ce soit le cas ... Notre solution est maintenant de vérifier dans les fichiers .rst générés pour les modules Ansible, et d'avoir une vérification dans la course Travis CI pour savoir si ces fichiers .rst sont à jour w.r.t. les fichiers source du module. –