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

Write translated Markdown documentation pages in temporal directory #21

Merged
merged 21 commits into from
Feb 25, 2022

Conversation

mondeja
Copy link
Owner

@mondeja mondeja commented Aug 19, 2021

Fixes #17

This is done, the problem is that PO files inside docs/ folder are written during the build, even if are written on post_build event. The possible solutions are:

  • Store PO translations in other folder outside of docs/. It seems very convenient to store them there, but currently Mkdocs does not offer a way to write to docs/ without entering in a infinite reload loop when serving files. Just using locale_dir and documeting it.
  • Wait for Allow to unwatch files with LiveReloadServer mkdocs/mkdocs#2777. This would allow to unwatch PO files. The problem here is that when PO file changes, it would not be reloaded, but this inconvenient doesn't seem very important anyways.

Breaking changes

  • Default dest_filename_template has been changed from {{language}}/{{page.file.dest_path}} to {{language}}/{{file.dest_path}}.

@coveralls
Copy link

coveralls commented Feb 25, 2022

Pull Request Test Coverage Report for Build 1898981712

  • 139 of 150 (92.67%) changed or added relevant lines in 7 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.5%) to 96.398%

Changes Missing Coverage Covered Lines Changed/Added Lines %
mkdocs_mdpo_plugin/plugin.py 70 74 94.59%
mkdocs_mdpo_plugin/config.py 12 19 63.16%
Totals Coverage Status
Change from base Build 999587926: -0.5%
Covered Lines: 455
Relevant Lines: 472

💛 - Coveralls

@mondeja mondeja added the bug Something isn't working label Feb 25, 2022
@mondeja mondeja marked this pull request as ready for review February 25, 2022 14:01
@mondeja mondeja merged commit 3bfb42b into master Feb 25, 2022
@mondeja mondeja deleted the fix-on_serve branch February 25, 2022 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create translation markdown pages inside temporal directory
2 participants