crickets-and-comb / crickets-and-comb/shared
Make docs multilingual with `sphinx-intl`.
Open
documentation
enhancement
help wanted
- Dominant language
- Makefile
- Stars
- 2
- Forks
- 0
- 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
Contributor guide
Research direction
Start with the linked Sphinx internationalization guide and the example workflow, then inspect how this repository currently builds its documentation. Define the supported languages and translation workflow; done means the documentation can be built and maintained in multiple languages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100