Compiler la documentation Sphinx avec Wercker
Aperçu
Voici un résumé des paramètres de compilation de documents Sphinx avec Wercker avec des captures d'écran.
procédure
Importez le référentiel cible depuis Créer → Application de Wercker.
L'écran après l'importation est le suivant, alors passez à l'onglet Workflow.
De là, ouvrez les paramètres du pipeline build.
Faites défiler l'écran de configuration du pipeline build pour afficher l'élément Niveau d'autorisation.
Et le "niveau d'autorisation" empêche les autres d'exécuter le pipeline,
Sélectionnez également ʻexécuter le pipelinepour que le journal ne soit pas publié par négligence. Ajoutez égalementgh-pages à ʻIgnore branches.
Si vous oubliez cela, après avoir poussé le document vers gh-pages, la compilation recommencera.
Ensuite, revenez à l'onglet Workflow et créez un nouveau pipeline.
Nommez le nouveau pipeline deploy et définissez le type de hook par défaut. La valeur par défaut est le paramètre de connexion au pipeline précédent.
Pour télécharger le document compilé sur GitHub
Enregistrez le jeton d'accès sur GitHub en tant que variable d'environnement dans ce pipeline.
Définissez le nom de la variable d'environnement sur GIT_TOKEN et cochez l'option protected.
Les jetons GitHub peuvent être obtenus sur https://github.com/settings/tokens.
Pour les dépôts publics, il vous suffit de cocher public_repo.
Pour les référentiels privés, vous devrez peut-être cocher repo (non essayé).
Après avoir ajouté la variable d'environnement GIT_TOKEN, changez le niveau d'autorisation sur Exécuter des pipelines et créez un pipeline.
Ensuite, connectez le pipeline deploy créé précédemment à build pour créer un nouveau flux de travail.
De plus, modifiez Sur la ou les branche (s) pour qu'elle ne fonctionne que lorsque vous la poussez vers le maître.
Enfin, ce devrait être comme suit.
Enfin, ajoutez wercker.yml au référentiel.
Par exemple, lors de la compilation de la source dans le dossier docs avec Sphinx, wercker.yml ressemble à ceci:
wercker.yml
box: jkawamoto/ghp-box
build:
steps:
- jkawamoto/sphinx:
basedir: docs
packages: sphinx_rtd_theme
deploy:
steps:
- jkawamoto/ghp-import:
token: $GIT_TOKEN
basedir: docs/build/html
Dans cet exemple, sphinx_rtd_theme est utilisé.
On suppose que le document compilé est généré dans docs / build / html.
Sinon, modifiez basedir en fonction de votre environnement.
Voir ci-dessous pour une description des encadrés et des étapes.
Recommended Posts