Skip to content

màj: utilisation de htmlserve au lieu de serve dans le Makefile #1919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 13, 2022

Conversation

eviau
Copy link

@eviau eviau commented Nov 5, 2022

En lien avec #1918 .

Je ne suis pas 100% convaincue que c'est la façon de faire ce changement... Suggestions (et explications) bienvenues.

Avec make htmlview, je réussi à générer la doc localement mais je ne vois pas comment accéder à la version traduite... j'ai regardé sur d'autres repos de doc python - exemple - et je ne vois pas trop ce que je dois changer.

C'est probablement pas le moment de faire ce changement - je vous laisse en juger :)

@JulienPalard
Copy link
Member

Attention htmlview et serve ne font pas du tout la même chose : htmlview fait un build puis lance un serveur HTTP alors que serve ne fait que lancer un serveur HTTP.

Mais c'est vrai qu'htmlview est sympa.

Je serai plutôt d'avis d'ajouter une règle htmlview plutôt que de modifier la règle serve.

Comme ça un make serve chez nous fait un make serve chez cpython, on ne casse les habitudes de personne.

Et un make htmlview chez nous fait un make htmlview sur cpython : c'est prévisible.

Pour implémenter la règle htmlview tu peux simplement changer le mode de la règle all:

.PHONY: htmlview
htmlview: MODE=htmlview
htmlview: all

car j'ai peur que comme tu l'as implémenté tu te retrouves avec la doc en anglais ?

@eviau
Copy link
Author

eviau commented Nov 6, 2022

D'accord - oui en effet, tel que je l'avais fait dans le premier commit, je n'avais que la version en anglais.

Maintenant je peux faire make htmlview et avoir la doc en français ✨

Je ne sais pas niveau historique git si ce que j'ai fait fonctionne ? Et niveau Makefile ?

Dites-moi s'il y a quoique ce soit :)

@JulienPalard
Copy link
Member

Niveau historique git ne t'en fais pas je ferai un "squash" avant de merger pour qu'il n'y en ai qu'un.

Ton commit est bon. Vu que tu viens de me faire découvrir qu'upstream ils ont retiré make serve, tu peux aussi retirer make serve chez nous, il ne fonctionne plus de toute façons...

Il faudra que tu mette à jour le CONTRIBUTING.rst pour refléter ce changement aussi.

@eviau
Copy link
Author

eviau commented Nov 13, 2022

Voilà - je ne pense pas avoir rien oublié... ?

@JulienPalard
Copy link
Member

Je ne suis pas encore utilisateur d'htmlview, mais je crois que dans contributing l'étape :

Une fois la traduction finie, il faut compiler la documentation,
c'est-à-dire générer les fichiers HTML affichés par le site, pour les
relire. Si la commande précédente s'est exécutée sans erreur, la
compilation ne devrait pas échouer.
.. code-block:: bash
    make

est à merger avec l'étape suivante ?

Si j'ai bien compris, avant on devait faire make suivi de make serve, alors que maintenant un seul make htmlview suffit ?

@christopheNan
Copy link
Contributor

Je ne suis pas encore utilisateur d'htmlview, mais je crois que dans contributing l'étape :

Une fois la traduction finie, il faut compiler la documentation,
c'est-à-dire générer les fichiers HTML affichés par le site, pour les
relire. Si la commande précédente s'est exécutée sans erreur, la
compilation ne devrait pas échouer.
.. code-block:: bash
    make

est à merger avec l'étape suivante ?

Si j'ai bien compris, avant on devait faire make suivi de make serve, alors que maintenant un seul make htmlview suffit ?

Oui, make htmlview fait les 2. Mais il bien écrit que make vérifie si la compilation passe et make htmlview permet de voir le rendu dans le navigateur (et fait la compilation au besoin).

@JulienPalard
Copy link
Member

Oui, make htmlview fait les 2. Mais il bien écrit que make vérifie si la compilation passe et make htmlview permet de voir le rendu dans le navigateur (et fait la compilation au besoin).

Il faut que je teste, ce dont j'ai peur c'est que le make puis make htmlview prenne presque deux fois plus longtemps que make + make serve ou make htmlview seul.

@christopheNan
Copy link
Contributor

christopheNan commented Nov 13, 2022 via email

@JulienPalard
Copy link
Member

AMHA, non, il detecte bien que la compilation est propre

Je viens de tester, 1m12 pour le make et 3s pour le make htmlview c'est propre ♥

@JulienPalard JulienPalard merged commit da21f1d into python:3.11 Nov 13, 2022
@JulienPalard
Copy link
Member

Merci @eviau !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants