search

nicolashainaux / sphinx-autodoc-annotation

Use Python 3 annotations in sphinx-enabled docstrings
BSD 3-Clause "New" or "Revised" License
43 stars 5 forks source link

PyPI version is still buggy #5

Closed nicolashainaux closed 8 years ago

nicolashainaux commented 8 years ago

The bug that led to this issue and this PR is corrected in the github repo but is still in the PyPI package. So anytime it's installed from PyPI it triggers the bug.

Would this be possible to release a new minor version on PyPI (like 1.0.1) that would include this bug correction?

As long as the bug remains in the PyPI package, it's indeed not possible(*) to use sphinx-autodoc-annotation if one wants to build the doc on readthedocs, because it installs the buggy version from PyPI... isn't it a bit of a shame?

I find this package really useful to use along python3 annotations.

(*) maybe using a dependency_links=[''] in setup() but this is not really good practice and might not be supported in the future

ghost commented 8 years ago

@nicolashainaux would you be interested in maintaining the package? I'd like to get rid of ownership.

nicolashainaux commented 8 years ago

Hum, I don't understand its mechanisms very deeply, even if it's not a very long script, I can see it's bound to Sphinx (I don't know its API neither). Not sure to be able to answer to questions or to bring it improvements later.

So I must say it's a temptation to say yes mainly because it would mean I would be able to update the PyPI version. But on another hand, it would be stupid not understanding it deep enough. I am not sure I would be able to resolve issue #4 (improvement), for instance, without a lot of time. Would you stay around as contributor at least?

ghost commented 8 years ago

Sorry @nicolashainaux , I'm really looking into getting rid of this ownership. I don't use it.

nicolashainaux commented 8 years ago

Alright then, as you don't use it, and as I use it, it would be better that I take ownership.

ghost commented 8 years ago

What is your pypi username?

nicolashainaux commented 8 years ago

Same as here: nicolashainaux

ghost commented 8 years ago

@nicolashainaux a little late (I've been busy, sorry), but it's done.

nicolashainaux commented 8 years ago

I just published the version containing the patch on PyPI, so I close this issue and the related ones.