gwastro / pycbc

Core package to analyze gravitational-wave data, find signals, and study their parameters. This package was used in the first direct detection of gravitational waves (GW150914), and is used in the ongoing analysis of LIGO/Virgo data.
http://pycbc.org
GNU General Public License v3.0
307 stars 344 forks source link

Start pushing tags to permanently-kept documentation pages #4778

Open GarethCabournDavies opened 1 month ago

GarethCabournDavies commented 1 month ago

Here I am starting to put together an idea on how to provide documentation for every release. I.e. instead of only having https://pycbc.org/pycbc/latest/html/, we would have https://pycbc.org/pycbc/v2.4.X/html/ as well, which points to the documentation at that release

Standard information about the request

This change affects continuous integration and the documentation

This change has been proposed using the contribution guidelines

This change will require a new release to ensure that it is correctly enacted

Motivation

This is best practice anyway, but there is an issue at #2504

Contents

Plan for next steps

Testing performed

I'm not sure how to test this without making a release!

ahnitz commented 1 month ago

@GarethCabournDavies I think this is a long overdue good thing to do. Thank you for looking into this!

GarethCabournDavies commented 1 week ago

I think the only way this can be tested is it it is just merged and see if it runs for the next release