flatpak-docs icon indicating copy to clipboard operation
flatpak-docs copied to clipboard

readthedocs check: not useful for translations?

Open boredsquirrel opened this issue 1 year ago • 1 comments

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.

boredsquirrel avatar Sep 13 '24 18:09 boredsquirrel

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 (https://github.com/flatpak/flatpak-docs/pull/370)

rffontenelle avatar Sep 26 '24 23:09 rffontenelle