Docs site versions

[kelly-sovacool]

Changes

Configures the docs site + github action to host multiple versions

One-time set up steps:

• delete all files in gh-pages

  git switch gh-pages
  git rm -rf $(git ls-files)
  git commit -m 'docs: delete gh-pages files to prepare for mike'

• check out the previous release tag and deploy it

  git checkout v3.0.3
  mike deploy 3.0 latest --push --update-aliases --branch gh-pages

• set the default landing page:

  mike set-default latest

• deploy the dev version from main

  git switch main
  mike deploy dev --push --update-aliases --branch gh-pages

After this PR is merged into main, from then on the dev version will be updated automatically when new commits are merged into main, and the latest version will automatically be set to the latest release.

Issues

resolves #95

PR Checklist

(Strikethrough any points that are not applicable.)

• This comment contains a description of changes with justifications, with any relevant issues linked.
• Update docs if there are any API changes.
• Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

[samarth8392]

doc/deploy is failing with error mike: command not found

Run mike deploy 3.0.3 latest \
  mike deploy 3.0.3 latest \
    --push \
    --update-aliases \
    --branch gh-pages
  shell: /usr/bin/bash -e {0}
  env:
    actor: 41898[2](https://github.com/CCBR/XAVIER/actions/runs/10255589303/job/28373546318#step:7:2)82+github-actions[bot]
    GH_TOKEN: ***
    pythonLocation: /opt/hostedtoolcache/Python/[3](https://github.com/CCBR/XAVIER/actions/runs/10255589303/job/28373546318#step:7:3).11.9/x6[4](https://github.com/CCBR/XAVIER/actions/runs/10255589303/job/28373546318#step:7:4)
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.11.9/x64/lib/pkgconfig
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.9/x64
    Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.9/x64
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.9/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.11.9/x64/lib
    VERSION: 3.0.3
    ALIAS: latest
/home/runner/work/_temp/[5](https://github.com/CCBR/XAVIER/actions/runs/10255589303/job/28373546318#step:7:5)da50c4d-d9e8-4c5e-ace[6](https://github.com/CCBR/XAVIER/actions/runs/10255589303/job/28373546318#step:7:6)-e4c93b282346.sh: line 1: mike: command not found
Error: Process completed with exit code 12[7](https://github.com/CCBR/XAVIER/actions/runs/10255589303/job/28373546318#step:7:7).

[kelly-sovacool]

I forgot to update docs/requirements.txt -- should be fixed now!

[kopardev]

@kelly-sovacool , @samarth8392
Should the GHA pages build and deployment run? I thought docs will be "replacing" it. Will this create some form of conflict?

[kelly-sovacool]

Yes, the docs workflow updates the content in the gh-pages branch, and pages build and deployment is what actually deploys the content in that branch to the web.

[kelly-sovacool]

You'll notice that there is no workflow file in .github/workflows/ that defines pages build and deployment. This is what GitHub runs when you have github pages turned on in repo settings.