https://github.com/atsphinx/mini18n
https://github.com/atsphinx/mini18n
hacktoberfest python sphinx sphinx-extension sphinx-intl
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/atsphinx/mini18n
- Owner: atsphinx
- License: apache-2.0
- Created: 2024-03-23T10:13:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T18:11:01.000Z (about 2 years ago)
- Last Synced: 2025-03-12T20:18:45.416Z (over 1 year ago)
- Topics: hacktoberfest, python, sphinx, sphinx-extension, sphinx-intl
- Language: Python
- Homepage: https://atsphinx.github.io/mini18n/
- Size: 68.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
================
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