Repository navigation
class/function summary tables only show first line of docstrings - #231
Conversation
|
I put this question on stackoverflow, and it looks like there is an answer that could be useful: http://stackoverflow.com/questions/10718846/use-first-paragraph-instead-of-first-line-in-sphinx-autosummary However, this might require that we bundle a modified autosummary (or we can submit it as a patch to sphinx). |
|
It turned out to be possible to just copy over the relevant part of @taldcroft - note that I also had to slightly adjust some of the |
|
And see https://bitbucket.org/birkenfeld/sphinx/issue/943/autosummary-doesnt-always-get-first - that fixes the issue in sphinx, so if it is adopted we could alter Automodsumm to only include this stuff if the sphinx version is too old. |
|
@eteq - No problem with the io.ascii doc changes. |
|
I'll go ahead and merge this, and issue a second PR that address the issue I was waiting on fixing. |
fixes autosummary tables only showing first line of docstring
fixes autosummary tables only showing first line of docstring
…entence fixes autosummary tables only showing first line of docstring
As discussed in #219, the tables generated by autosummary and automodapi only take the first line of the docstrings, rather than the first sentence or paragraph as is expected from the numpydoc standard.