search

Chilipp / autodocsumm

Extending your autodoc API docs with a summary
Apache License 2.0
48 stars 14 forks source link

Allow disabling nesting of autosummary tables #20

Closed piyushk closed 5 years ago

piyushk commented 5 years ago

I've opened a draft PR for allowing disabling of nesting of autosummary tables. The use case is described in #19

Closes #19, #13

Once we finalize on the solution, I can add the necessary tests.

Chilipp commented 5 years ago

👍 Looks great! Thanks a lot! We should add some tests here to verify it works. If you want, I can do this quickly tomorrow

Chilipp commented 5 years ago

It simply requires an rst file in the sphinx_supp directory and a small test method the checks it in test_autodocsumm.py

piyushk commented 5 years ago

Sounds good. I can add the test/documentation tomorrow and update this PR.

I'll also submit a new PR that rehashes #13 since that solution is necessary to prevent warnings from sphinx, as we treat warnings as errors.

piyushk commented 5 years ago

@Chilipp: The PR is now ready for review.

piyushk commented 5 years ago

I've also added a fix that subsumes #13 using versions, since sphinx-doc/sphinx#6475 was merged and released in version 2.2, and add_autodocumenter has been available since version 0.6.

That change stops warnings from being generated starting with sphinx version 2.2, as we treat warnings as errors in our setup.

Chilipp commented 5 years ago

Hey @piyushk! This is really great, thanks a lot for this nice implementation! It looks all good to me and I only added some minor changes in the RST documentations (https://github.com/Chilipp/autodocsumm/pull/20/commits/46998d4afb4c7d6363fae90953f6dcc9b2f78a87 and https://github.com/Chilipp/autodocsumm/pull/20/commits/fe6da6befb1eb41a99c0e242803719eb4ad7c3be). Also thanks a lot for implementing the proposed changes from https://github.com/Chilipp/autodocsumm/pull/13!

I will merge this PR when the CI finishes and make a new release tomorrow.

piyushk commented 5 years ago

Thanks! The changes look good. I appreciate the quick turnaround and release.

Chilipp commented 5 years ago

Alright, new release is published (v0.1.11) and uploaded to PyPi. conda-forge should be finished later today.

Thank you very much again for your work on this!