Skip to content

[ci] feat: add docs build workflow - #46

Merged
Wangmerlyn merged 1 commit into
mainfrom
doc-build-ci
Nov 12, 2025
Merged

[ci] feat: add docs build workflow#46
Wangmerlyn merged 1 commit into
mainfrom
doc-build-ci

Conversation

@Wangmerlyn

Copy link
Copy Markdown
Owner

No description provided.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +22 to +26
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .
pip install -r docs/requirements.txt

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Ensure PyTorch is installed from the proper index

The docs workflow installs the project via pip install ., which pulls in the mandatory torch dependency. In the existing CI workflow, PyTorch is installed separately using pip install torch --index-url https://download.pytorch.org/whl/cpu because the wheels are not published on the default PyPI index. Without that override, pip install . cannot resolve torch and the docs job will fail before mkdocs build runs. The step should install PyTorch from the same index or otherwise avoid the dependency to make the workflow reliable.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mark this for now, comeback to this if anything happens

@Wangmerlyn
Wangmerlyn merged commit 4b84979 into main Nov 12, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant