OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
42 stars 50 forks source link

have versioned docs. I.e. a nice visible drop-down on the web interface such that people can switch from nightly to release #347

Closed poshul closed 1 year ago

poshul commented 1 year ago
          I think it would be better to have versioned docs. I.e. a nice visible drop-down on the web interface such that people can switch from nightly to release. This means we would just keep the currently supported versions up-to-date here.

Would be nice to have a versions file in the OpenMs repo that lists the supported versions which is then also used by our nightly jobs to request those python versions from the runners. If those runners do not support these versions anymore we get an error. The docs and website would then read the versions from that file.

_Originally posted by @jpfeuffer in https://github.com/OpenMS/pyopenms-docs/pull/340#discussion_r1105910595_

See https://stackoverflow.com/questions/49331914/enable-versions-in-sidebar-in-sphinx-read-the-docs-theme

how to display versioned docs better. Feel free to delegate to the doc team.

jpfeuffer commented 1 year ago

This will also require a little bit of rethinking how to write our environment.yml/requirements.txt files and our actions. Things to consider:

jpfeuffer commented 1 year ago

Related #348

timosachsenberg commented 1 year ago

I added you because it sounds like it requires a bit deeper understanding of the build steps / requirements.

jpfeuffer commented 1 year ago

see #354. One of the many benefits.

jpfeuffer commented 1 year ago

No understanding needed by the way. I will figure out the Readthedocs. This task is just to display what Readthedocs already does.

timosachsenberg commented 1 year ago

any update here?

jpfeuffer commented 1 year ago

See the linked PR. Apparently tapasweni abandoned the project again. So I think we should go with my PR.

timosachsenberg commented 1 year ago

what was the update on this project. I think you have been working on something on the retreat

jpfeuffer commented 1 year ago

No, not regarding this

timosachsenberg commented 1 year ago

I think this is done? image