Added mkdocs based documentation files for the new wiki #1960
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A brief description of the purpose of the changes contained in this PR.
Added mkdocs based documentation files for the new wiki.
For now, I am using
uvto build and run the tools needed to build the wiki (similar tool to Poetry)Once
uvis installed, you can build the website withPDF=1 uv run mkdocs build, or usePDF=1 uv run mkdocs serveto make mkdocs serve the website on a localhost address.I am using
miketo add versions to the wiki. To use it, if you already have thegh-pagesbranch on your machine, you can just run this command :uv run mike serveIf you don't have the gh-pages branch, or if you want to deploy a new version of the wiki, you can use the following commands:
PDF=1 uv run mike deploy -u *versionNumber* *alias*versionNumberwill be the version of Codabench that the wiki is for (1.19.0 for example)aliasis the version alias. We use latest for the wiki that is build for the master branch of Codabench, and Dev for the wiki that is build for the develop branch of Codabench-uallows mike to override aversionNumberif it already existsYou then have to set the default target for
miketo use with the following command: `uv run mike set-default latest``Once this is done, you can run
uv run mike serveto see the latest version of the wiki as well as previous versions (if available) from the dropdown menu on the top left of the wiki.Note that the version of the wiki should always match the version of Codabench.
I added an automated workflow for Github Action to rebuild the wiki each time there is a change in the develop branch and when we create a new tag for production.
devalias which is not shown by default to users loading the wikiChecklist