Skip to content

Commit ec80c19

Browse files
committed
multiple languages
1 parent f370776 commit ec80c19

File tree

14 files changed

+167
-1
lines changed

14 files changed

+167
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ __pycache__/
2222
# IDEs
2323
/.idea/
2424
/.vscode/
25+
/docs/locale/de/LC_MESSAGES/build/

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@
77
[link-tests]: https://github.com/your_github_username/scverse-doc/actions/workflows/test.yml
88
[badge-docs]: https://img.shields.io/readthedocs/scverse-doc
99

10+
11+
1012
Collection of tutorials for scverse packages.

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@
2626
# The full version, including alpha/beta/rc tags
2727
release = info["Version"]
2828

29+
locale_dirs = ['locale/'] # path is example but recommended.
30+
gettext_compact = False
31+
2932
bibtex_bibfiles = ["references.bib"]
3033
templates_path = ["_templates"]
3134
nitpicky = True # Warn about broken links

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88
99
references.md
1010
11-
notebooks/example
11+
notebooks/example_md.md
1212
```
13+

docs/locale/de/LC_MESSAGES/index.mo

672 Bytes
Binary file not shown.

docs/locale/de/LC_MESSAGES/index.po

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2022, scverse team.
3+
# This file is distributed under the same license as the Python package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Python 0.0.1\n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2022-12-08 13:45+0100\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <[email protected]>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=utf-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
"Generated-By: Babel 2.11.0\n"
19+
20+
#: ../../../README.md:2
21+
msgid "scverse tutorials"
22+
msgstr "scverse tutorials DEUTSCH"
23+
24+
#: ../../../README.md:4
25+
msgid ""
26+
"[![Tests][badge-tests]][link-tests] [![Documentation][badge-docs]][link-"
27+
"docs]"
28+
msgstr ""
29+
30+
#: ../../../README.md:4
31+
msgid "Tests"
32+
msgstr "Prüfungen"
33+
34+
#: ../../../README.md:4
35+
msgid "Documentation"
36+
msgstr "Dokumentation"
37+
38+
#: ../../../README.md:11
39+
msgid "Collection of tutorials for scverse packages."
40+
msgstr "Sammlung von Tutorials für scverse-Pakete."
41+
429 Bytes
Binary file not shown.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2022, scverse team.
3+
# This file is distributed under the same license as the Python package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Python 0.0.1\n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2022-12-08 13:45+0100\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <[email protected]>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=utf-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
"Generated-By: Babel 2.11.0\n"
19+
20+
#: ../../notebooks/example.ipynb:10002
21+
msgid "Example notebook"
22+
msgstr ""
23+
429 Bytes
Binary file not shown.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2022, scverse team.
3+
# This file is distributed under the same license as the Python package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Python 0.0.1\n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2022-12-08 14:58+0100\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <[email protected]>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=utf-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
"Generated-By: Babel 2.11.0\n"
19+
20+
#: ../../notebooks/example_md.md:16
21+
msgid "Example notebook"
22+
msgstr ""
23+
467 Bytes
Binary file not shown.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2022, scverse team.
3+
# This file is distributed under the same license as the Python package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Python 0.0.1\n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2022-12-08 13:45+0100\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <[email protected]>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=utf-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
"Generated-By: Babel 2.11.0\n"
19+
20+
#: ../../references.md:1
21+
msgid "References"
22+
msgstr "Referenzen"
23+

docs/notebooks/example_md.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
jupytext:
3+
text_representation:
4+
extension: .md
5+
format_name: myst
6+
format_version: 0.13
7+
jupytext_version: 1.14.2
8+
kernelspec:
9+
display_name: Python 3.6.8 64-bit
10+
language: python
11+
name: python3
12+
---
13+
14+
+++ {"pycharm": {"name": "#%% md\n"}}
15+
16+
# Example notebook
17+
18+
```{code-cell} ipython3
19+
---
20+
pycharm:
21+
name: '#%%
22+
23+
'
24+
---
25+
import numpy as np
26+
from anndata import AnnData
27+
import scverse_doc
28+
```
29+
30+
```{code-cell} ipython3
31+
---
32+
pycharm:
33+
name: '#%%
34+
35+
'
36+
---
37+
adata = AnnData(np.random.normal(size=(20, 10)))
38+
```
39+
40+
```{code-cell} ipython3
41+
---
42+
pycharm:
43+
name: '#%%
44+
45+
'
46+
---
47+
scverse_doc.pp.basic_preproc(adata)
48+
```

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ doc = [
3131
"myst-nb",
3232
"sphinxcontrib-bibtex>=1.0.0",
3333
"sphinx-autodoc-typehints",
34+
"sphinx-intl",
3435
# For notebooks
3536
"ipykernel",
3637
"sphinx-copybutton",

0 commit comments

Comments
 (0)