Skip to content

Commit

Permalink
doc: For PyPI users
Browse files Browse the repository at this point in the history
  • Loading branch information
attakei committed Mar 23, 2024
1 parent ea0dcff commit ae582cf
Showing 1 changed file with 50 additions and 2 deletions.
52 changes: 50 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,59 @@
atsphinx-mini18n
================

Sphinx builder for i18n site on single deployment
.. 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
===============

.. code: console
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

0 comments on commit ae582cf

Please sign in to comment.