Viewing rendered docs from a PR to check

未關閉
#363 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
32/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
github-actions

研究方向

Review the referenced .github/workflows/docs.yml in the Excalibur repository to understand the proposed rendered-docs workflow, then inspect this repository’s documentation and CI configuration. Done means a pull request can render the documentation for checking before merge.

由索引模型根據 Issue 內容生成。

描述

enhancement

We don't have any way of viewing rendered docs from a PR to check them before merging do we?

For what is worth, we do that in the excalibur benchmarking repository: https://github.com/ukri-excalibur/excalibur-tests/blob/ede38fa104eed72557233cbfc76b230727973791/.github/workflows/docs.yml (this is using mkdocs rather than jekyll, but to give an idea of what one can do to accomplish that).

Originally posted by @giordano in https://github.com/UCL-ARC/python-tooling/issues/358#issuecomment-2077433013

主要語言
Python
星號
62
分支
10
平均合併
5 天 19 小時
30 天內合併 PR
6

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

UCL-ARC/python-tooling 的其他 Issue

查看 UCL-ARC/python-tooling 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。