Skip to content

atsphinx/mini18n

Repository files navigation

atsphinx-mini18n

https://github.com/atsphinx/mini18n/actions/workflows/main.yml/badge.svg?branch=main

Sphinx builder for i18n site on single deployment.

Overview

This provides custom builders that generate html document per translated languages on to outdir.

$ cd /path/to/doc
$ cat conf.py
...
mini18n_support_languages = ["en", "ja"]
...

$ make mini18n-html
$ ls _build/mini18n-html
en index.html ja

Getting started

You should ready for i18n configurations and manage translated files.

Install

pip install atsphinx-mini18n

Configuration

extensions = [
    "atsphinx.mini18n",
]

mini18n_default_language = "en"
mini18n_support_languages = ["en", "ja"]

Run build

$ make mini18n-html

OR

$ make mini18n-dirhtml