docs: Add version switcher

[nicu1989]

Improvement

Description

Use current theme(pydata_sphinx_theme) version switcher dropdown to display a version selector. Because the switcher requires a json, the versions file is parsed into versions.json.
Also a css update of the version switcher is required to proper display(vertical scrollbar) the list of versions.

Because of a current bug #194 this PR will not show the docs preview. However I created another PR for preview only: https://nicu1989.github.io/score/pr-7/

Here is also a picture of the dropdown:

Also there is a way to view the versions file in browser using the json file: https://eclipse-score.github.io/score/versions.json

Related ticket

closes [#250 ] (improvement ticket)

[danwos]

Looks good to me. Thanks for the PR 👍

[dcalavrezo-qorix]

there is a docs-cleanup.yml workflow which handles removal of previews

I think you should update the JSON in there too

  steps:
      - uses: actions/checkout@v4
        with:
          ref: gh-pages
      - name: Remove version
        run: |
          if [[ ${{ github.event_name }} == "pull_request" ]]; then
            VERSION="pr-${{ github.event.pull_request.number }}"
          else
            VERSION="${{ github.ref_name }}"
          fi

          echo "VERSION=$VERSION" >> $GITHUB_ENV

          # Delete the folder and remove the version from the versions file
          rm -rf "${VERSION}"
          sed -i "/^$VERSION$/d" versions

[nicu1989]

there is a docs-cleanup.yml workflow which handles removal of previews

I think you should update the JSON in there too

  steps:
      - uses: actions/checkout@v4
        with:
          ref: gh-pages
      - name: Remove version
        run: |
          if [[ ${{ github.event_name }} == "pull_request" ]]; then
            VERSION="pr-${{ github.event.pull_request.number }}"
          else
            VERSION="${{ github.ref_name }}"
          fi

          echo "VERSION=$VERSION" >> $GITHUB_ENV

          # Delete the folder and remove the version from the versions file
          rm -rf "${VERSION}"
          sed -i "/^$VERSION$/d" versions

true & done. thank you

[AlexanderLanin]

This PR will maintain a versions and a versons.json file? Shouldn't we get rid of the first one then?

[nicu1989]

This PR will maintain a versions and a versons.json file? Shouldn't we get rid of the first one then?

You are right, versions is published only for information and we have now versions.json which can be easily viewed in browser. I removed versions handling. All new PR will be stored in versions.json.