search

readthedocs / sphinx-hoverxref

Sphinx extension to show tooltips with content embedded when hover a reference.
https://sphinx-hoverxref.readthedocs.io/
MIT License
95 stars 40 forks source link

Help with packaging `sphinx-hoverxref` for `conda-forge` #237

Closed BSGalvan closed 1 year ago

BSGalvan commented 1 year ago

Hello!

I am currently in the process of submitting a recipe to conda-forge for getting sphinx-hoverxref.

~Seeing as how this package is currently in beta~ Even though the package is now stable, it would be wonderful if any of the package devs could accept to be a fellow maintainer of the conda-forge recipe. This would help keep the recipe (and consequently conda-forge builds) fresh.

You can see the (draft) PR, here.

Thanks in advance and cheers!

humitos commented 1 year ago

Hi @BSGalvan! Thanks for opening this issue.

Why do you say this package is in beta? Have you read this somewhere in our documentation? Or do you refer that the conda-forge recipe is in beta?

In any case, this package is not in beta anymore and we have release the version 1.x some time ago. If we are saying we are in beta in some place, please point us out there and we will change it.

BSGalvan commented 1 year ago

Ah my bad, I didn't see the 1.x badge here on GitHub!

The pypi.org page warns of the package being in beta, which is where I picked up the misconception. My apologies!

humitos commented 1 year ago

Oh, yeah, that's because https://github.com/readthedocs/sphinx-hoverxref/blob/1.1.3/pyproject.toml#L26

However, that's changed in main, https://github.com/readthedocs/sphinx-hoverxref/blob/main/pyproject.toml#L26

Sorry about the confusion.

BSGalvan commented 1 year ago

@humitos

For the recipe, I will need to specify a minimum python version with which sphinx-hoverxref will be compatible.

From my cursory glance at tox.ini, it seems that testing happens down to python 3.8. Would it be correct if I set a dependency of python >= 3.8, or is there another constraint somewhere else that I've missed?

humitos commented 1 year ago

Would it be correct if I set a dependency of python >= 3.8, or is there another constraint somewhere else that I've missed?

That would be fine, yeah.

BSGalvan commented 1 year ago

The recipe has successfully passed CI checks, and it ready to be put on conda-forge!

@humitos, before I publish the PR, would it be okay if I add you to the list of maintainers here?

humitos commented 1 year ago

I don't have experience with conda-forge, so I don't think I'll be useful there

humitos commented 1 year ago

I don't have experience with conda-forge, so I don't think I'll be useful there

BSGalvan commented 1 year ago

No worries, then!

I will mark the PR ready for now. In the future if any of the maintainers here want to hop on, I should be able to add them in following instructions here (note to self).

Let me know if that is alright, and thank you for your time!

humitos commented 1 year ago

Thanks for doing this work and supporting this extension. I understand there is no more work required in this issue, so I'll close it