Adding Japanese Translation to a Documentation Site Built with Sphinx

Overview I had the opportunity to add Japanese translation to a documentation site built with sphinx, so this is a note for reference. The target is the following. https://github.com/artefactual/archivematica-storage-service-docs Method First, fork the target repository. Next, clone it. g c i d t a c t l o o m n - e d o h c t s t p s : / / g i t h u b . c o m / n a k a m u r a 1 9 6 / a r c h i v e m a t i c a - s t o r a g e - s e r v i c e - d o c s Here, we create a Python virtual environment. p s p p y o i i t u p p h r o c i i n e n n s s - t t m v a a e l l v n l l e v n / - b - r i u n p r v / g e e a r q n c a u v t d i i e r v e a p m t i e e p n t s . t x t Adding Libraries Add sphinx-intl to requirements.txt and install it. s s s p p p h h h i i i n n n x x x - - i a n u t t l o b u i l d p i p i n s t a l l - r r e q u i r e m e n t s . t x t (Optional) conf.py If language settings do not exist in conf.py, add them as follows. # l g l o e a L c t n a a t g n l e u g e x a u _ t g a d _ e g i c e r o = s m s p " e = a j t c a t [ t " i ' n l = g o s c F a a l l e s / e ' ] # # D o D i n r o e t c t s o h r o y r t t e o n s f t i o l r e e n t a r m a e n s s l a t i o n f i l e s Then run the gettext build. m a k e g e t t e x t Creating the Japanese Directory Running the following creates po files in locale/ja. s p h i n x - i n t l u p d a t e - p _ b u i l d / l o c a l e - l j a Editing Localization is done by editing the po files under locale/ja. Development The following command allows you to preview the site. s p h i n x - a u t o b u i l d . _ b u i l d / h t m l Build The following command stores the build results in _build/html. s p h i n x - b u i l d . _ b u i l d / h t m l Deployment n o # p # # c j a n e o o m : p S r c p i A H n g c b b d e u e m o a d l o c r a s u e : s b t i n g - l w u o n : i r s p e r n s h r s s t e t o e r u c l u t l n u e t D : a - s e s o w v r p e d n e - - - - # - o v n u n e e - e n p i n : k e e : l : s p y i a r s d p p c " e o t e o r n - - s u n u w n r n r e S n u w : r m l - s s n i u l h 1 r n s w n n , c " i o : s a s i a u a u n a a s i o e : o : : a d s o e . m s : r : l y p n n e m e t p m n p p m n s v T v m e t p n : n m : e y s 1 i : i y d : a - : s e s h y e : y i e : p : Z e e s h a m $ : b e s : 5 s r t w o g p : : : : t : t p : h : : : : t e g { u : d : S " s e e r o e r u h | h | i b h n i { u i e p i a i n N s o b a S a o I o i B n U u U a : t t b l D p a h o d t e O " g u c e c n n n n u x T i p c : h s u d e l c i n e T r n t t t - s s i - C l l t _ u t n p o t n s c e t i i v t - t l b d o i b b e t l y i x o c s u o u o e a m a d u a o u - p u o m o o n a s - n p n r l l i d d n i p s - y e n D f c n : l s s s l p l S l i s l a . l n s o u c a / P / i i p d r a / d g d a t t / c t r e f t c y s o d p - h e r u / e e t o d u h r l a e h t e n e r i . c t p h s p e e m e e l s e h t : p i n t i l t l s G p e n i s t c o u e n r x _ o f o m o t i l n G t n e k n p " n s e b r a a l y t o t I - o - 3 d t q D u y c d m H y a T d p u p . e a u o i t - e u - t H e r t y 1 n l i c l a p n b p i U p o @ t 0 c l r u d s a t a o B l g v h " i e m / g . P g n _ o r 4 o e m e h a e o a e T y e n # s - e n t r s u g s t O m s @ u n t m t - t e @ o K e s v S p t a l i a p s v E n 5 p g s t f r u 4 G N t r e r . i a t t i , u c a t o # c i s t t n i d x n t f . H o s s f e t A a p u k y d c a b a i a p j t g l p s t i # u @ e P l p h p s v _ a o i w e i t 3 u g w n e f r e g P p l s d w y y a e r a t o t } p u n h u h } l n t o s o s n h y t a i m q o v v f e u e e n e a r n t u l s a e e l i n c t d o o y e o w n s b d s G e t e a i t h p r t w e e y H e s n u e e d b n e p n P t r c a h o i g e d e e u s s r c u t n i o i n n - d p e r p o l g o r y e m s e s n t a s n d t o l a c t o e m s p t l e q t u e e . u e d . As a result, it is deployed as follows. https://nakamura196.github.io/archivematica-storage-service-docs/ Summary I hope this is helpful.

Overview#

Method#

Adding Libraries#

(Optional) conf.py#

Creating the Japanese Directory#

Editing#

Development#

Build#

Deployment#

Summary#

Overview

Method

Adding Libraries

(Optional) conf.py

Creating the Japanese Directory

Editing

Development

Build

Deployment

Summary