IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

.write_text(...) -> .write_text(..., encoding='utf8')

Browse Source
This commit is contained in:
Adam Turner
2022-04-27 03:11:08 +01:00
parent 24e3b7c8c8
commit 4674cc11c8
12 changed files with 65 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
tests/test_ext_autodoc_configs.py
View File

@@ -865,7 +865,8 @@ def test_autodoc_typehints_description_no_undoc(app):
'.. autofunction:: target.typehints.tuple_args\n'
'\n'
' :param x: arg\n'
' :return: another tuple\n'
' :return: another tuple\n',
encoding='utf8'
)
app.build()
context = (app.outdir / 'index.txt').read_text(encoding='utf8')
@@ -917,7 +918,8 @@ def test_autodoc_typehints_description_no_undoc_doc_rtype(app):
'\n'
'.. autofunction:: target.typehints.Math.horse\n'
'\n'
' :return: nothing\n'
' :return: nothing\n',
encoding='utf8'
)
app.build()
context = (app.outdir / 'index.txt').read_text(encoding='utf8')
@@ -961,7 +963,8 @@ def test_autodoc_typehints_description_no_undoc_doc_rtype(app):
def test_autodoc_typehints_description_with_documented_init(app):
(app.srcdir / 'index.rst').write_text(
'.. autoclass:: target.typehints._ClassWithDocumentedInit\n'
' :special-members: __init__\n'
' :special-members: __init__\n',
encoding='utf8'
)
app.build()
context = (app.outdir / 'index.txt').read_text(encoding='utf8')
@@ -992,7 +995,8 @@ def test_autodoc_typehints_description_with_documented_init(app):
def test_autodoc_typehints_description_with_documented_init_no_undoc(app):
(app.srcdir / 'index.rst').write_text(
'.. autoclass:: target.typehints._ClassWithDocumentedInit\n'
' :special-members: __init__\n'
' :special-members: __init__\n',
encoding='utf8'
)
app.build()
context = (app.outdir / 'index.txt').read_text(encoding='utf8')
@@ -1017,7 +1021,8 @@ def test_autodoc_typehints_description_with_documented_init_no_undoc_doc_rtype(a
# docstring.
(app.srcdir / 'index.rst').write_text(
'.. autoclass:: target.typehints._ClassWithDocumentedInit\n'
' :special-members: __init__\n'
' :special-members: __init__\n',
encoding='utf8'
)
app.build()
context = (app.outdir / 'index.txt').read_text(encoding='utf8')
@@ -1048,7 +1053,8 @@ def test_autodoc_typehints_both(app):
'\n'
'.. autofunction:: target.typehints.tuple_args\n'
'\n'
'.. autofunction:: target.overload.sum\n'
'.. autofunction:: target.overload.sum\n',
encoding='utf8'
)
app.build()
context = (app.outdir / 'index.txt').read_text(encoding='utf8')
@@ -1217,7 +1223,7 @@ def test_autodoc_type_aliases(app):
confoverrides={'autodoc_typehints': "description",
'autodoc_type_aliases': {'myint': 'myint'}})
def test_autodoc_typehints_description_and_type_aliases(app):
(app.srcdir / 'autodoc_type_aliases.rst').write_text('.. autofunction:: target.autodoc_type_aliases.sum')
(app.srcdir / 'autodoc_type_aliases.rst').write_text('.. autofunction:: target.autodoc_type_aliases.sum', encoding='utf8')
app.build()
context = (app.outdir / 'autodoc_type_aliases.txt').read_text(encoding='utf8')
assert ('target.autodoc_type_aliases.sum(x, y)\n'