crickets-and-comb / crickets-and-comb/reference_package

Make docs multilingual with `sphinx-intl`.

Open
#23 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement help wanted
Dominant language
Python
Stars
1
Forks
2
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

Open the contributing guide

Research direction

Start with the linked Sphinx internationalization guide and example, then inspect this repository’s documentation build configuration. Establish the languages, translation workflow, and build outputs in scope; done means the documentation can be built successfully in each agreed language.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, internationalization, localization
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.