oq-engine icon indicating copy to clipboard operation
oq-engine copied to clipboard

Tie the advanced manual to the engine version

Open micheles opened this issue 2 years ago • 1 comments

Currently it is generated only for master and it is impossible to go back to old versions (unless one looks at github). It should be put in standard places (latest, stable, X.Y.Z) as the regular manual.

micheles avatar Oct 04 '22 07:10 micheles

The template we're using also has an option to add a button that allows users to switch between versions of the documentation: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html

raoanirudh avatar Oct 05 '22 08:10 raoanirudh

@nastasi-oq, can we close this now?

micheles avatar Oct 20 '22 13:10 micheles

Currently, I see a static page with master and latest. I think it will be better to add the drop-down button with the corresponding engine version.

CatalinaYepes avatar Oct 20 '22 14:10 CatalinaYepes

Here is a screenshot of the drop-down button taken from pandas documentation @nastasi-oq Screenshot 2023-01-10 at 11 31 22

CatalinaYepes avatar Jan 10 '23 10:01 CatalinaYepes

I'm working on this new feature and I will extend it to the "user manual" too. Take in account that after the next release the dropdown will be populated with just 2 items:

3.16 LTS
master (target 3.17)

and so on for the next not LTS releases

3.16 LTS
3.17
master (target 3.18)

...

The effort to produce previous advanced manual versions would not be negligible and if you need it it must be discussed because not already implemented for github actions.

nastasi-oq avatar Jan 24 '23 14:01 nastasi-oq