Skip to content

Instantly share code, notes, and snippets.

@hayderimran7

hayderimran7/gist:179e0ca33d7c93429ba7

Created February 17, 2015 02:57
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save hayderimran7/179e0ca33d7c93429ba7 to your computer and use it in GitHub Desktop.
Save hayderimran7/179e0ca33d7c93429ba7 to your computer and use it in GitHub Desktop.
Download ZIP
Sphinx builder how to fix 'WARNING: Definition list ends without a blank line; unexpected unindent.'
Raw
gistfile1.txt
recently i came up with this warning which was failing my job .
The reason this warning happens is that for a multi-line comment/description, you should give '\' after each line except the last line.
so lets i have a doc comment like this:
'this is a test
comment which describes
something about this module.'
Above docstring will obviously in sphinx build job, so correct way is :
'this is a test \
comment which describes \
something about this module.'
Also if you are working with openstack related projects, be known the line limit is 79 characters.
Cheers
@manishlamichhane
Copy link

Nice. That helped. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment