Fix module docstring format for ismags reference article.#6611
Fix module docstring format for ismags reference article.#6611dschult merged 1 commit intonetworkx:mainfrom
Conversation
Improperly formatted Notes/References sections was causing a sphinx parsing error which led to a very poorly formatted html page. Fixing the numpydoc formatting for the module docstring + minor munging of the heading levels was sufficient to fix this.
|
This looks fine for content -- but the ISMAGS Object section has no space before it (the References section runs right up to it, while the other sections get some breathing room). I don't mind merging this as is, but is there an easy way to make the space between sections? (maybe just a blank line at end of doc_string? but maybe different autodoc magic in the .rst file?) |
Good point - I'm not sure why this happens. I'll try adding some newlines (in isomorphism.ismags.rst and/or the ismags module docstring) to see if I can't get an extra line break in there. There's still likely something funky with the numpydoc module docstring parsing so it may not be possible, but let's check! |
|
Okay, I've tried with adding extra newlines in both the reference doc as well as the module docstring and unfortunately that doesn't make any difference. I suspect this is something that will have to be fixed upstream. |
dschult
left a comment
There was a problem hiding this comment.
Thanks for trying out the newlines -- I didn't know if there was something about sphinx I didn't know about.
Let's merge these and we can fix minor stuff later.
Closes #6547
Improperly formatted Notes/References sections was causing a sphinx parsing error which led to a very poorly formatted html page.
Fixing the numpydoc formatting for the module docstring + minor munging of the heading levels should fix the issue.