Migrate documentation build to mkdocs

[amrit110]

PR Type

Documentation, Enhancement

Short Description

• This PR migrates documentation build from using sphinx to mkdocs which is cleaner, more reliable and easier to use.

TODO:

In a following PR, will add support for multiple versions using https://github.com/jimporter/mike.

[Copilot]

Copilot reviewed 18 out of 31 changed files in this pull request and generated no comments.

Files not reviewed (13)

• .github/workflows/docs_build.yml: Language not supported
• .github/workflows/docs_deploy.yml: Language not supported
• docs/overrides/partials/copyright.html: Language not supported
• docs/overrides/partials/logo.html: Language not supported
• docs/source/_templates/base.html: Language not supported
• docs/source/_templates/custom-class-template.rst: Language not supported
• docs/source/_templates/custom-module-template.rst: Language not supported
• docs/source/_templates/page.html: Language not supported
• docs/source/reference/api/index.rst: Language not supported
• docs/source/reference/api/vec_inf.api.client.rst: Language not supported
• docs/source/reference/api/vec_inf.api.models.rst: Language not supported
• docs/source/reference/api/vec_inf.api.rst: Language not supported
• docs/source/reference/api/vec_inf.api.utils.rst: Language not supported

Comments suppressed due to low confidence (1)

.pre-commit-config.yaml:16

• The use of the '--unsafe' flag may bypass important validations in the check-yaml hook; please review whether this option is necessary and acceptable for your project's security posture.

args: [--unsafe]

[XkunW]

The API usage docs seems broken, everything is duplicated. Included 2 continuous screenshots of the table of contents bar for the API usage page.

[Copilot]

Copilot reviewed 18 out of 31 changed files in this pull request and generated no comments.

Files not reviewed (13)

• .github/workflows/docs_build.yml: Language not supported
• .github/workflows/docs_deploy.yml: Language not supported
• docs/overrides/partials/copyright.html: Language not supported
• docs/overrides/partials/logo.html: Language not supported
• docs/source/_templates/base.html: Language not supported
• docs/source/_templates/custom-class-template.rst: Language not supported
• docs/source/_templates/custom-module-template.rst: Language not supported
• docs/source/_templates/page.html: Language not supported
• docs/source/reference/api/index.rst: Language not supported
• docs/source/reference/api/vec_inf.api.client.rst: Language not supported
• docs/source/reference/api/vec_inf.api.models.rst: Language not supported
• docs/source/reference/api/vec_inf.api.rst: Language not supported
• docs/source/reference/api/vec_inf.api.utils.rst: Language not supported

Comments suppressed due to low confidence (2)

.pre-commit-config.yaml:16

• Verify that the use of the '--unsafe' argument for the check-yaml hook is intentional as it may bypass certain safety checks.

args: [--unsafe]

docs/index.md:3

• Confirm that the updated file paths correctly reflect the current repository structure after migrating to MkDocs.

This repository provides an easy-to-use solution to run inference servers on [Slurm](https://slurm.schedmd.com/overview.html)-managed computing clusters using [vLLM](https://docs.vllm.ai/en/latest/). **All scripts in this repository runs natively on the Vector Institute cluster environment**. To adapt to other environments, update the environment variables in [`vec_inf/client/_vars.py`](https://github.com/VectorInstitute/vector-inference/blob/main/vec_inf/client/_vars.py), [`vec_inf/client/_config.py`](https://github.com/VectorInstitute/vector-inference/blob/main/vec_inf/client/_config.py), [`vllm.slurm`](https://github.com/VectorInstitute/vector-inference/blob/main/vec_inf/vllm.slurm), [`multinode_vllm.slurm`](https://github.com/VectorInstitute/vector-inference/blob/main/vec_inf/multinode_vllm.slurm) and [`models.yaml`](https://github.com/VectorInstitute/vector-inference/blob/main/vec_inf/config/models.yaml) accordingly.

[XkunW]

LGTM!

[Copilot]

Pull Request Overview

This PR migrates the documentation build from Sphinx to MkDocs for improved reliability and ease of use. Key changes include:

• Removal of Sphinx configuration and custom JavaScript assets.
• Updates to documentation index and README to reference new client paths.
• Addition of a new GitHub workflow for building and deploying MkDocs documentation and a minor change in the pre-commit configuration.

Reviewed Changes

Copilot reviewed 18 out of 31 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
docs/source/conf.py	Removed Sphinx configuration file.
docs/source/_static/custom.js	Removed Sphinx-specific custom JavaScript configuration.
docs/index.md	Updated content and reference links to align with MkDocs migration.
docs/api.md	Added new Python API reference documentation.
README.md	Updated documentation links to reflect new file paths.
.pre-commit-config.yaml	Added "--unsafe" argument to the check-yaml hook configuration.
.github/workflows/docs.yml	Added new workflow file to automate MkDocs build and deploy process.

Files not reviewed (13)

• .github/workflows/docs_build.yml: Language not supported
• .github/workflows/docs_deploy.yml: Language not supported
• docs/overrides/partials/copyright.html: Language not supported
• docs/overrides/partials/logo.html: Language not supported
• docs/source/_templates/base.html: Language not supported
• docs/source/_templates/custom-class-template.rst: Language not supported
• docs/source/_templates/custom-module-template.rst: Language not supported
• docs/source/_templates/page.html: Language not supported
• docs/source/reference/api/index.rst: Language not supported
• docs/source/reference/api/vec_inf.api.client.rst: Language not supported
• docs/source/reference/api/vec_inf.api.models.rst: Language not supported
• docs/source/reference/api/vec_inf.api.rst: Language not supported
• docs/source/reference/api/vec_inf.api.utils.rst: Language not supported

[jwilles]

LGTM