From 377f1e8ef5b2a07fd95a1f09e22e7c80a453797d Mon Sep 17 00:00:00 2001 From: Marco Rossi Date: Sun, 31 Jul 2022 21:26:20 +0200 Subject: [PATCH 1/8] Add class with non-ascii members to non-ascii testcase --- .../tests/cases/non_ascii/input/index.rst | 1 + ...tests.example_module.nonascii.NonAscii.rst | 19 ++++++++++++++++++ .../non_ascii/output/index.rst.automodapi | 20 +++++++++++++++++++ .../non_ascii/output/index.rst.automodsumm | 7 +++++++ .../tests/example_module/nonascii.py | 14 +++++++++++++ 5 files changed, 61 insertions(+) create mode 100644 sphinx_automodapi/tests/cases/non_ascii/output/api/sphinx_automodapi.tests.example_module.nonascii.NonAscii.rst create mode 100644 sphinx_automodapi/tests/example_module/nonascii.py diff --git a/sphinx_automodapi/tests/cases/non_ascii/input/index.rst b/sphinx_automodapi/tests/cases/non_ascii/input/index.rst index a0275eb..dc7cf3b 100644 --- a/sphinx_automodapi/tests/cases/non_ascii/input/index.rst +++ b/sphinx_automodapi/tests/cases/non_ascii/input/index.rst @@ -1,3 +1,4 @@ Ceçi est un exemple qui inclus des charactères non-ASCII .. automodapi:: sphinx_automodapi.tests.example_module.functions +.. automodapi:: sphinx_automodapi.tests.example_module.nonascii diff --git a/sphinx_automodapi/tests/cases/non_ascii/output/api/sphinx_automodapi.tests.example_module.nonascii.NonAscii.rst b/sphinx_automodapi/tests/cases/non_ascii/output/api/sphinx_automodapi.tests.example_module.nonascii.NonAscii.rst new file mode 100644 index 0000000..1ea0c55 --- /dev/null +++ b/sphinx_automodapi/tests/cases/non_ascii/output/api/sphinx_automodapi.tests.example_module.nonascii.NonAscii.rst @@ -0,0 +1,19 @@ +NonAscii +======== + +.. currentmodule:: sphinx_automodapi.tests.example_module.nonascii + +.. autoclass:: NonAscii + :show-inheritance: + + .. rubric:: Methods Summary + + .. autosummary:: + + ~NonAscii.get_ß + ~NonAscii.get_äöü + + .. rubric:: Methods Documentation + + .. automethod:: get_ß + .. automethod:: get_äöü diff --git a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodapi b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodapi index a80b228..f7e71cd 100644 --- a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodapi +++ b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodapi @@ -12,3 +12,23 @@ Functions .. automodsumm:: sphinx_automodapi.tests.example_module.functions :functions-only: :toctree: api + + +sphinx_automodapi.tests.example_module.nonascii Module +------------------------------------------------------ + +.. automodule:: sphinx_automodapi.tests.example_module.nonascii + +Classes +^^^^^^^ + +.. automodsumm:: sphinx_automodapi.tests.example_module.nonascii + :classes-only: + :toctree: api + +Class Inheritance Diagram +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automod-diagram:: sphinx_automodapi.tests.example_module.nonascii + :private-bases: + :parts: 1 diff --git a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm index 8aa64a3..fb4ef02 100644 --- a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm +++ b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm @@ -6,3 +6,10 @@ add subtract multiply +.. currentmodule:: sphinx_automodapi.tests.example_module.nonascii + +.. autosummary:: + :toctree: api + + NonAscii + diff --git a/sphinx_automodapi/tests/example_module/nonascii.py b/sphinx_automodapi/tests/example_module/nonascii.py new file mode 100644 index 0000000..9cb184a --- /dev/null +++ b/sphinx_automodapi/tests/example_module/nonascii.py @@ -0,0 +1,14 @@ +__all__ = ['NonAscii'] + +class NonAscii(object): + def get_äöü(self): + """ + Return a string with common umlauts like äöüß + """ + return 'äöü' + + def get_ß(self): + """ + Return a string with the eszett symbol + """ + return 'ß' From 1f1c9ab1ae1edca14d30180fe75cf8eecb284dd6 Mon Sep 17 00:00:00 2001 From: Marco Rossi Date: Sun, 31 Jul 2022 21:28:14 +0200 Subject: [PATCH 2/8] Set default encoding to utf8 Sphinx expects utf8 and this may set to something different by default on Windows. --- sphinx_automodapi/automodsumm.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx_automodapi/automodsumm.py b/sphinx_automodapi/automodsumm.py index bd6d9f1..dd2dfc2 100644 --- a/sphinx_automodapi/automodsumm.py +++ b/sphinx_automodapi/automodsumm.py @@ -487,7 +487,7 @@ def generate_automodsumm_docs(lines, srcfn, app=None, suffix='.rst', new_files.append(fn) - f = open(fn, 'w') + f = open(fn, 'w', encoding='utf8') try: From cf0d5c041ff59d12b600f7f11b39cf474d9cfb1e Mon Sep 17 00:00:00 2001 From: Marco Rossi Date: Mon, 1 Aug 2022 22:28:07 +0200 Subject: [PATCH 3/8] Add blank line --- sphinx_automodapi/tests/example_module/nonascii.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sphinx_automodapi/tests/example_module/nonascii.py b/sphinx_automodapi/tests/example_module/nonascii.py index 9cb184a..ccded8e 100644 --- a/sphinx_automodapi/tests/example_module/nonascii.py +++ b/sphinx_automodapi/tests/example_module/nonascii.py @@ -1,5 +1,6 @@ __all__ = ['NonAscii'] + class NonAscii(object): def get_äöü(self): """ From fe3e5cfa707e38a8a3160d395ce5b34286e41861 Mon Sep 17 00:00:00 2001 From: Marco Rossi Date: Mon, 1 Aug 2022 23:44:01 +0200 Subject: [PATCH 4/8] Set default language to fix warning on readthedocs --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c453cc2..5dafd40 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From fd0b599c0eaf75c424c9c707e429df1ab7a633f9 Mon Sep 17 00:00:00 2001 From: Marco Rossi Date: Tue, 2 Aug 2022 08:48:04 +0200 Subject: [PATCH 5/8] Add empty line --- .../tests/cases/non_ascii/output/index.rst.automodsumm | 1 + 1 file changed, 1 insertion(+) diff --git a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm index fb4ef02..62138f0 100644 --- a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm +++ b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm @@ -6,6 +6,7 @@ add subtract multiply + .. currentmodule:: sphinx_automodapi.tests.example_module.nonascii .. autosummary:: From e58092ddb4477800e93db8e44dae6c2f82595459 Mon Sep 17 00:00:00 2001 From: Marco Rossi Date: Tue, 2 Aug 2022 08:48:23 +0200 Subject: [PATCH 6/8] Update changelog --- CHANGES.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index e4ff835..a99bbf9 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,6 +4,8 @@ Changes in sphinx-automodapi 0.15.0 (unreleased) ------------------- +- Fixed issue with non-ascii characters in object members on Windows as the default encoding there is not ``utf8`` [#153] + 0.14.1 (2022-01-12) ------------------- From e5a52cfc8f1d6932b2487681db98209c3dd68740 Mon Sep 17 00:00:00 2001 From: Marco Rossi Date: Tue, 2 Aug 2022 20:02:46 +0200 Subject: [PATCH 7/8] Remove empty line as the tests fail with it --- .../tests/cases/non_ascii/output/index.rst.automodsumm | 1 - 1 file changed, 1 deletion(-) diff --git a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm index 62138f0..fb4ef02 100644 --- a/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm +++ b/sphinx_automodapi/tests/cases/non_ascii/output/index.rst.automodsumm @@ -6,7 +6,6 @@ add subtract multiply - .. currentmodule:: sphinx_automodapi.tests.example_module.nonascii .. autosummary:: From 953ce096c66ad3a15ff429146ec652b968e76ac9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Brigitta=20Sip=C5=91cz?= Date: Mon, 8 Aug 2022 16:23:12 -0700 Subject: [PATCH 8/8] rephrase changelog [skip ci] --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index a99bbf9..0d329c6 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,7 +4,7 @@ Changes in sphinx-automodapi 0.15.0 (unreleased) ------------------- -- Fixed issue with non-ascii characters in object members on Windows as the default encoding there is not ``utf8`` [#153] +- Fixed issue with non-ascii characters in object members when the encoding is not ``utf8`` [#153] 0.14.1 (2022-01-12) -------------------