<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Jun 15, 2016 at 6:29 PM, Kacper Kowalik <span dir="ltr"><<a href="mailto:xarthisius.kk@gmail.com" target="_blank">xarthisius.kk@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi all!<br>
As you may know, most of the yt's docstrings are written using so called "numpy-style" [1]. It's not a default Sphinx's format and it requires an extension to parse it. Up till now we've been using numpydoc [2] to handle it. However, numpydoc is a bit buggy and not actively developed. My main issue with numpydoc is that it throws a bazillion of bogus warnings bloating jenkins logs to 100Mb for every docs' build.<br>
<br>
There's an alternative extension: napoleon [3] that I'd like to try. The resulting documentation looks a bit different and it may also require a little bit of work to iron out the rough edges.<br>
I issued a PR 2238 [4] to show docs with the new look.<br>
<br></blockquote><div><br></div><div>I like the new look. It'll certainly be nice to clear these annoying repetitive warning messages that get dumped to our doc build output.</div><div><br></div><div>If anyone has issues, we should be able to tweak the appearance by adjusting the CSS in our docs theme.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
I'd appreciate your comments.<br>
Cheers,<br>
Kacper<br>
<br>
[1] <a href="https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#class-docstring" rel="noreferrer" target="_blank">https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#class-docstring</a><br>
[2] <a href="https://pypi.python.org/pypi/numpydoc" rel="noreferrer" target="_blank">https://pypi.python.org/pypi/numpydoc</a><br>
[3] <a href="http://www.sphinx-doc.org/en/stable/ext/napoleon.html" rel="noreferrer" target="_blank">http://www.sphinx-doc.org/en/stable/ext/napoleon.html</a><br>
[4] <a href="https://bitbucket.org/yt_analysis/yt/pull-requests/2238" rel="noreferrer" target="_blank">https://bitbucket.org/yt_analysis/yt/pull-requests/2238</a><br>
_______________________________________________<br>
yt-dev mailing list<br>
<a href="mailto:yt-dev@lists.spacepope.org" target="_blank">yt-dev@lists.spacepope.org</a><br>
<a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" rel="noreferrer" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
</blockquote></div><br></div></div>