crickets-and-comb / crickets-and-comb/comb_utils
Make docs multilingual with `sphinx-intl`.
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
We can use the `sphinx-intl` extension to make our docs multilingual. https://www.sphinx-doc.org/en/master/usage/advanced/intl.html
Here's an example of how to use it: https://www.codingwiththomas.com/blog/my-sphinx-best-practice-for-a-multiversion-documentation-in-different-languages
See https://github.com/crickets-and-comb/shared/issues/52
Contributor guide
Research direction
Start by reading the linked Sphinx internationalization guide and the example workflow, then inspect the related issue crickets-and-comb/shared#52 for project context. Clarify which documentation languages and translation workflow are required; done should mean the documentation supports the agreed multilingual setup using sphinx-intl.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, internationalization
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100