Merge pull request #544 from yukinarit/add-japanese-translation

Add mdbook project for Japanese translation
yukinarit · Jun 10, 2024 · 55df223 · 55df223
2 parents b564f3f + a3cc4cd
commit 55df223
Show file tree

Hide file tree

Showing 16 changed files with 53 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -37,6 +37,7 @@ docs:
 	mkdir -p docs out/api out/guide/en
 	$(POETRY) run pdoc -e serde=https://github.com/yukinarit/pyserde/tree/main/serde/ serde -o out/api
 	mdbook build -d ../../out/guide/en ./docs/en
+	mdbook build -d ../../out/guide/ja ./docs/ja
 
 open-docs:
 	$(POETRY) run pdoc -e serde=https://github.com/yukinarit/pyserde/tree/main/serde serde

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@
     <a href = "https://piptrends.com/package/pyserde" alt = "pyserde Downloads Last Month"><img alt="pyserde Downloads Last Month by pip Trends" src="https://assets.piptrends.com/get-last-month-downloads-badge/pyserde.svg"></a>
 </p>
 <p align="center">
-  <a href="https://yukinarit.github.io/pyserde/guide/en">Guide</a> | <a href="https://yukinarit.github.io/pyserde/api/serde.html">API Docs</a> | <a href="https://github.com/yukinarit/pyserde/tree/main/examples">Examples</a>
+  <a href="https://yukinarit.github.io/pyserde/guide/en">Guide🇬🇧</a> | <a href="https://yukinarit.github.io/pyserde/guide/ja">ガイド🇯🇵</a> | <a href="https://yukinarit.github.io/pyserde/api/serde.html">API Docs</a> | <a href="https://github.com/yukinarit/pyserde/tree/main/examples">Examples</a>
 </p>
 
 ## Overview

diff --git a/docs/en/book.toml b/docs/en/book.toml
@@ -7,4 +7,4 @@ title = "pyserde documentation"
 
 [output.html]
 git-repository-url = "https://github.com/yukinarit/pyserde"
-edit-url-template = "https://github.com/yukinarit/pyserde/edit/main/{path}"
+edit-url-template = "https://github.com/yukinarit/pyserde/edit/main/en/{path}"
diff --git a/docs/ja/SUMMARY.md b/docs/ja/SUMMARY.md
@@ -0,0 +1,13 @@
+# Summary
+
+- [Introduction](introduction.md)
+- [Getting Started](getting-started.md)
+- [Data Formats](data-formats.md)
+- [Types](types.md)
+- [Decorators](decorators.md)
+- [Class Attributes](class-attributes.md)
+- [Field Attributes](field-attributes.md)
+- [Union](union.md)
+- [Type Checking](type-check.md)
+- [Extension](extension.md)
+- [FAQ](faq.md)
diff --git a/docs/ja/book.toml b/docs/ja/book.toml
@@ -0,0 +1,10 @@
+[book]
+authors = ["yukinarit"]
+language = "ja"
+multilingual = true
+src = "./"
+title = "pyserde documentation"
+
+[output.html]
+git-repository-url = "https://github.com/yukinarit/pyserde"
+edit-url-template = "https://github.com/yukinarit/pyserde/edit/main/ja/{path}"
diff --git a/docs/ja/class-attributes.md b/docs/ja/class-attributes.md
diff --git a/docs/ja/data-formats.md b/docs/ja/data-formats.md
diff --git a/docs/ja/decorators.md b/docs/ja/decorators.md
diff --git a/docs/ja/extension.md b/docs/ja/extension.md
diff --git a/docs/ja/faq.md b/docs/ja/faq.md
diff --git a/docs/ja/field-attributes.md b/docs/ja/field-attributes.md
diff --git a/docs/ja/getting-started.md b/docs/ja/getting-started.md
diff --git a/docs/ja/introduction.md b/docs/ja/introduction.md
@@ -0,0 +1,27 @@
+# Introduction
+
+`pyserde`は[dataclasses](https://docs.python.org/3/library/dataclasses.html)ベースのシンプルで強力なシリアライゼーションライブラリです。
+
+クラスに`@serde`デコレータを付けるだけで、クラスを様々なデータフォーマットに変換可能になります。
+
+```python
+@serde
+class Foo:
+    i: int
+    s: str
+    f: float
+    b: bool
+```
+
+`Foo`クラスは以下のようにJSONにシリアライズ出来るようになります。
+
+```python
+>>> to_json(Foo(i=10, s='foo', f=100.0, b=True))
+'{"i":10,"s":"foo","f":100.0,"b":true}'
+```
+
+また、JSONから`Foo`クラスにデシリアライズも出来るようになります。
+```python
+>>> from_json(Foo, '{"i": 10, "s": "foo", "f": 100.0, "b": true}')
+Foo(i=10, s='foo', f=100.0, b=True)
+```
diff --git a/docs/ja/type-check.md b/docs/ja/type-check.md
diff --git a/docs/ja/types.md b/docs/ja/types.md
diff --git a/docs/ja/union.md b/docs/ja/union.md