NASA-Planetary-Science / sbpy

A Python package for small bodies research
https://sbpy.org/
Other
67 stars 34 forks source link

Website linked to 'latest' documentation #377

Closed mkelley closed 1 year ago

mkelley commented 1 year ago

The website is currently linked to the latest documentation. What I've been noticing is that most users are not installing the latest version, but whatever is available via pip or conda, i.e., the last stable version. Should we update the sbpy.org link to point to the stable version? Or, just to sbpy.readthedocs.io and we can configure latest vs. stable on the RTD end (currently it is stable).

jianyangli commented 1 year ago

I think it's a good idea to link to the stable version. Advanced users will find out the latest dev version by themselves if they need. Most users don't care about the dev version anyway. Linking to readthedocs website is also fine. Would the readthedocs website be synced with the version available via pip or conda?

jianyangli commented 1 year ago

Why do I see version number v0.1.dev for the latest version? Shouldn't it be v0.4.dev?

Also, the current version on sbpy.org also needs to be updated to 0.4.

mkelley commented 1 year ago

I'm trying to understand that, too. It might be https://docs.readthedocs.io/en/stable/build-customization.html?highlight=setuptools_scm#avoid-having-a-dirty-git-index which is an issue that astropy also had.

mkelley commented 1 year ago

Readthedocs builds stable versions of the documentation whenever a release is tagged in githb. v0.4 is available there now.

mkelley commented 1 year ago

These issues seem to be fixed now: #378