Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

>1 inline literals on 1 line causes description to disappear #27

Closed
hmellor opened this issue Sep 10, 2020 · 1 comment
Closed

>1 inline literals on 1 line causes description to disappear #27

hmellor opened this issue Sep 10, 2020 · 1 comment

Comments

@hmellor
Copy link

hmellor commented Sep 10, 2020

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.

Args:
    argument (``int``, optional): Placeholder argument. Defaults to ``4``.

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.

Args:
    argument (``int``, optional): Placeholder argument.
        Defaults to ``4``.
  • argument (int, optional) – Placeholder argument. Defaults to 4.
@hmellor
Copy link
Author

hmellor commented Sep 25, 2020

Closing because it was fixed on then main Sphinx repo here

@hmellor hmellor closed this as completed Sep 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant