Skip to main content

Sphinx builder for i18n site on single deployment

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atsphinx_mini18n-0.3.0.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

atsphinx_mini18n-0.3.0-py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page