crickets-and-comb/shared

Make docs multilingual with `sphinx-intl`.

Open

#52 opened on Mar 26, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Makefile (0 forks)auto 404
documentationenhancementhelp wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

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
Follow the sphinx intl documentation to set up multilingual documentation, create .pot files, and generate translations.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGitSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70