-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
indentation in docstring lists doesn't seem to work #8
Comments
Like so, right?
By the way, this formatting is accessible by putting a block between a pair of triple-backticks (```) |
Fixed my GitHub comment but the issue with sphinx soliditydomain persists :( |
Hey sorry it's taking so long... I dunno if I have that much bandwidth unfortunately. Also my bad: I had meant that the triple backticks worked on GitHub for preformatted text blocks. Could you provide some more information about the issue? Is it that you're unable to use rst numbered lists inside of documentation comments, and what does your Sphinx setup look like? |
Indeed. I'm using the autodoc feature such as here (rst file):
and then have inline comments like this (sol file):
If I try to break the first numbered item into two lines I get the error as explained above. |
This works:
This doesn't work and an error "Enumerated list ends without a blank line; unexpected unindent." is thrown:
I tried all kinds of list formats (numbers, bullets etc) but they all fail in the same way. If the second item in the latter example is separated from the first one with a blank line, it isn't identified as a list item.
The text was updated successfully, but these errors were encountered: