Metadata-Version: 2.4
Name: atsphinx-mini18n
Version: 0.4.1
Summary: Sphinx builder for i18n site on single deployment
Project-URL: Repository, https://github.com/atsphinx/mini18n
Project-URL: Issues, https://github.com/atsphinx/mini18n/issues
Project-URL: Document, https://atsphinx.github.io/mini18n/
Author-email: Kazuya Takei <myself@attakei.net>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.8
Requires-Dist: sphinx
Description-Content-Type: text/x-rst

================
atsphinx-mini18n
================

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

Sphinx builder for i18n site on single deployment.

Overview
========

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

.. code:: console

   $ 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
-------

.. code:: console

   pip install atsphinx-mini18n

Configuration
-------------

.. code:: python

   extensions = [
       "atsphinx.mini18n",
   ]

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

Run build
---------

.. code:: console

   $ make mini18n-html

   OR

   $ make mini18n-dirhtml
