multiple languages

.gitignore

@@ -22,3 +22,4 @@ __pycache__/
 # IDEs
 /.idea/
 /.vscode/
+/docs/locale/de/LC_MESSAGES/build/

README.md

@@ -7,4 +7,6 @@
 [link-tests]: https://github.com/your_github_username/scverse-doc/actions/workflows/test.yml
 [badge-docs]: https://img.shields.io/readthedocs/scverse-doc
 
+
+
 Collection of tutorials for scverse packages.

docs/conf.py

@@ -26,6 +26,9 @@
 # The full version, including alpha/beta/rc tags
 release = info["Version"]
 
+locale_dirs = ['locale/']   # path is example but recommended.
+gettext_compact = False
+
 bibtex_bibfiles = ["references.bib"]
 templates_path = ["_templates"]
 nitpicky = True  # Warn about broken links

docs/index.md

@@ -8,5 +8,6 @@
 
 references.md
 
-notebooks/example
+notebooks/example_md.md
 ```
+

docs/locale/de/LC_MESSAGES/index.po

@@ -0,0 +1,41 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, scverse team.
+# This file is distributed under the same license as the Python package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: Python 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-12-08 13:45+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.11.0\n"
+
+#: ../../../README.md:2
+msgid "scverse tutorials"
+msgstr "scverse tutorials DEUTSCH"
+
+#: ../../../README.md:4
+msgid ""
+"[![Tests][badge-tests]][link-tests] [![Documentation][badge-docs]][link-"
+"docs]"
+msgstr ""
+
+#: ../../../README.md:4
+msgid "Tests"
+msgstr "Prüfungen"
+
+#: ../../../README.md:4
+msgid "Documentation"
+msgstr "Dokumentation"
+
+#: ../../../README.md:11
+msgid "Collection of tutorials for scverse packages."
+msgstr "Sammlung von Tutorials für scverse-Pakete."
+

docs/locale/de/LC_MESSAGES/notebooks/example.po

@@ -0,0 +1,23 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, scverse team.
+# This file is distributed under the same license as the Python package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: Python 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-12-08 13:45+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.11.0\n"
+
+#: ../../notebooks/example.ipynb:10002
+msgid "Example notebook"
+msgstr ""
+

docs/locale/de/LC_MESSAGES/notebooks/example_md.po

@@ -0,0 +1,23 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, scverse team.
+# This file is distributed under the same license as the Python package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: Python 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-12-08 14:58+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.11.0\n"
+
+#: ../../notebooks/example_md.md:16
+msgid "Example notebook"
+msgstr ""
+

docs/locale/de/LC_MESSAGES/references.po

@@ -0,0 +1,23 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, scverse team.
+# This file is distributed under the same license as the Python package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: Python 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-12-08 13:45+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.11.0\n"
+
+#: ../../references.md:1
+msgid "References"
+msgstr "Referenzen"
+

docs/notebooks/example_md.md

@@ -0,0 +1,48 @@
+---
+jupytext:
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+    jupytext_version: 1.14.2
+kernelspec:
+  display_name: Python 3.6.8 64-bit
+  language: python
+  name: python3
+---
+
++++ {"pycharm": {"name": "#%% md\n"}}
+
+# Example notebook
+
+```{code-cell} ipython3
+---
+pycharm:
+  name: '#%%
+
+    '
+---
+import numpy as np
+from anndata import AnnData
+import scverse_doc
+```
+
+```{code-cell} ipython3
+---
+pycharm:
+  name: '#%%
+
+    '
+---
+adata = AnnData(np.random.normal(size=(20, 10)))
+```
+
+```{code-cell} ipython3
+---
+pycharm:
+  name: '#%%
+
+    '
+---
+scverse_doc.pp.basic_preproc(adata)
+```

pyproject.toml

@@ -31,6 +31,7 @@ doc = [
     "myst-nb",
     "sphinxcontrib-bibtex>=1.0.0",
     "sphinx-autodoc-typehints",
+    "sphinx-intl",
     # For notebooks
     "ipykernel",
     "sphinx-copybutton",