Start pushing tags to permanently-kept documentation pages

[GarethCabournDavies]

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

• Add a new job to the CI which is only run when a release is made.
• This will also add the documentation to a new folder within the gh-pages repo
• The gh-pages repo should then have the release kept whenever the documentation is built again, and will be pushed for each version

Plan for next steps

• Get a dropdown of links for each version (plus latest) added to the bottom of the sidebar on the documentation pages
• Add a link to the latest released version of the documentation to pypi

Testing performed

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

• [x] The author of this pull request confirms they will adhere to the code of conduct

[ahnitz]

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

[GarethCabournDavies]

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

[GarethCabournDavies]

I forgot that I hadn't un-drafted and re-requested review for this!

[GarethCabournDavies]

Ping @ahnitz

[duboism]

Hello,

Is there any plan to finish this soon ? As pointed in #2504, it is rather useful to have stable URL.

[GarethCabournDavies]

Hello,

Is there any plan to finish this soon ? As pointed in #2504, it is rather useful to have stable URL.

Thanks for the reminder - this had just dropped off my radar, and was awaiting review. If the changes are still valid this looks to be ready to go

[duboism]

Hello, Is there any plan to finish this soon ? As pointed in #2504, it is rather useful to have stable URL.

Thanks for the reminder - this had just dropped off my radar, and was awaiting review. If the changes are still valid this looks to be ready to go

Thank you. Let us know if we can help. I'm not familiar with GitHub pages but do you know if there will be a version selector in the page (like https://microscope.readthedocs.io/en/stable/ - see bottom left).

[GarethCabournDavies]

Hello, Is there any plan to finish this soon ? As pointed in #2504, it is rather useful to have stable URL.

Thanks for the reminder - this had just dropped off my radar, and was awaiting review. If the changes are still valid this looks to be ready to go

Thank you. Let us know if we can help. I'm not familiar with GitHub pages but do you know if there will be a version selector in the page (like https://microscope.readthedocs.io/en/stable/ - see bottom left).

Thanks, I'm not sure how to do the version selector either, but the changes here should at least give some stable pages!