Closed hmellor closed 4 years ago
Having multiple inline literals on the same line causes the description to not be included when building to HTML.
Using the google template as an example.
Args: argument (``int``, optional): Placeholder argument. Defaults to ``4``.
Appears like this in HTML:
argument (int, optional) –
int
Placing the second inline literal on a newline seems to fix the problem, but this reduces the readability of the Docstring.
argument (int, optional) – Placeholder argument. Defaults to 4.
4
Closing because it was fixed on then main Sphinx repo here
Problem
Having multiple inline literals on the same line causes the description to not be included when building to HTML.
Example
Using the google template as an example.
Appears like this in HTML:
argument (
int
, optional) –Workaround
Placing the second inline literal on a newline seems to fix the problem, but this reduces the readability of the Docstring.
argument (
int
, optional) – Placeholder argument. Defaults to4
.