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

Conditional backslash addition in autodoc

Browse Source
This commit is contained in:
Jakob Lykke Andersen
2020-03-20 13:26:03 +01:00
parent 088f26278f
commit 581f425b4e
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
sphinx/ext/autodoc/__init__.py
View File

@@ -1043,8 +1043,9 @@ class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # typ
sig = inspect.signature(self.object.__init__, bound_method=True) sig = inspect.signature(self.object.__init__, bound_method=True)
args = stringify_signature(sig, show_return_annotation=False, **kwargs) args = stringify_signature(sig, show_return_annotation=False, **kwargs)
# escape backslashes for reST if self.env.config.strip_signature_backslash:
args = args.replace('\\', '\\\\') # escape backslashes for reST
args = args.replace('\\', '\\\\')
return args return args
def document_members(self, all_members: bool = False) -> None: def document_members(self, all_members: bool = False) -> None:
@@ -1437,8 +1438,9 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): # type:
sig = inspect.signature(self.object, bound_method=True) sig = inspect.signature(self.object, bound_method=True)
args = stringify_signature(sig, **kwargs) args = stringify_signature(sig, **kwargs)
# escape backslashes for reST if self.env.config.strip_signature_backslash:
args = args.replace('\\', '\\\\') # escape backslashes for reST
args = args.replace('\\', '\\\\')
return args return args
def add_directive_header(self, sig: str) -> None: def add_directive_header(self, sig: str) -> None: