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

readthedocs check: not useful for translations? #527

Open
boredsquirrel opened this issue Sep 13, 2024 · 1 comment
Open

readthedocs check: not useful for translations? #527

boredsquirrel opened this issue Sep 13, 2024 · 1 comment

Comments

@boredsquirrel
Copy link

boredsquirrel commented Sep 13, 2024

This is probably low priority.

The readthedocs build check only builds the english version, so it is not useful for translation PRs.

A way to make this useful, flexible or customizable could help here.

@rffontenelle
Copy link
Contributor

In my experience with RTD and Sphinx documentations, I normally see these solutions:

  • Do browse the build status of the RTD project for your language, which in the case of flatpak-docs is: https://readthedocs.org/projects/flatpak-de/builds/. Read The Docs requires each language to be in their own specific project, and they are linked to the main RTD project. This way, when browsing docs.flatpak.org, you are able to switch languages.
  • You can yourself build locally following instructions are in the this repository's README.
  • To have implemented a GitHub Actions that build translated docs and sphinx-lint each PO file, to bring up errors for each one. I implemented this in Python Packaging User Guide e started something in here as well (Add l10n workflow to build translated docs #370)

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

No branches or pull requests

3 participants