crickets-and-comb/shared

Make docs multilingual with `sphinx-intl`.

Open

#52 aberto em 26 de mar. de 2025

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Makefile (0 forks)auto 404
documentationenhancementhelp wanted

Métricas do repositório

Stars
 (2 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Siga a documentação do sphinx intl para configurar a documentação multilíngue, criar arquivos .pot e gerar traduções.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGitSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70