Skip to content
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

Documentation en francais #55

Merged
merged 10 commits into from
Dec 11, 2023
Merged

Documentation en francais #55

merged 10 commits into from
Dec 11, 2023

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Dec 8, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • CHANGES.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Add localization files and Makefile commands

Does this PR introduce a breaking change?

Yes. Documentation structure has been changed: Now offers "en" and "fr" as options.

Other information:

@Zeitsperre Zeitsperre added the documentation Improvements or additions to documentation label Dec 8, 2023
@Zeitsperre Zeitsperre self-assigned this Dec 8, 2023
@Zeitsperre
Copy link
Collaborator Author

@TC-FF

Bonnes nouvelles : J'ai une preuve de concept qui semblait à marcher ! Aussi, j'ai modifié le Makefile pour que tu puisses rouler make docs pour générer les deux langues en même temps.

Pas si bonnes nouvelles : La façon dont les traductions marchent pour ReadTheDocs c'est que tu dois créer un projet individuel par traduction, alors, on a maintenant une deuxième projet qui s'appelle xhydro-fr. J'ai envoyé une invitation à ton compte.

J'ai pris le choix de ne pas traduire les docstrings des fonctions (on skip cette étape pour diminuer le risque d'avoir des docstrings obsolètes), mais si tu veux qu'on ajoute ça aussi, je pourrais changer ce comportement.

Fais-moi savoir si tu veux ajouter les traductions directement dans ce PR.

À+

@Zeitsperre Zeitsperre marked this pull request as ready for review December 8, 2023 20:47
Copy link
Collaborator

@TC-FF TC-FF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On fera les traductions dans une prochaine PR

@TC-FF TC-FF merged commit aba59ff into main Dec 11, 2023
12 checks passed
@TC-FF TC-FF deleted the documentation_en_francais branch December 11, 2023 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants