Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JupyterBook #160

Merged
merged 12 commits into from
Nov 27, 2024
Merged

Add JupyterBook #160

merged 12 commits into from
Nov 27, 2024

Conversation

NY57
Copy link
Contributor

@NY57 NY57 commented Nov 26, 2024

変更点

  • 従来のGitHubPagesのルートページ(doc/index.html)の代わりにJupyterBook製のHTMLが利用されるように変更を加えました
  • 既存のAPIリファレンスは同じURLかつ同じドキュメント生成方法のままにしました。
    • これに関連して、JupyterBook製のHTMLから既存のAPIリファレンスへのリンクは外部リンクの形としています。

相談事項

  • TaskおよびGitHubActionsの運用について、なるべくTask側に各種コマンドを集約し、GitHubActionsはそれを実行するだけにする方が良いと考えていますが、この認識は間違いないでしょうか?
    • この認識が正しい場合、GitHubActionsのドキュメント生成のワークフローがTaskを使っていない形をしているので、修正が必要と考えています。
  • 既存のAPIリファレンスのうち、Python製のものはSphinxのAutoAPIをJupyterBook内で使うことで統合が可能になります。その対応を本PRに含めた方が良いでしょうか?

補足事項

https://github.com/Jij-Inc/ommx/actions/runs/12040838304/job/33571508249?pr=160#step:6:28
上記のGitHubActionsのログにあるArtifactをローカルにダウンロードし、index.htmlをブラウザで開くことで見た目を確認することができます。

@NY57 NY57 marked this pull request as ready for review November 27, 2024 00:02
@NY57 NY57 requested a review from termoshtt November 27, 2024 00:03
@termoshtt
Copy link
Collaborator

requirements.txt でなくて pyproject.toml にしたいけど、それは uv への移行 #165 で一緒にやることにしてこのPRではこのままやる

TaskおよびGitHubActionsの運用について、なるべくTask側に各種コマンドを集約し、GitHubActionsはそれを実行するだけにする方が良いと考えていますが、この認識は間違いないでしょうか?

Yes. これは部分的には #159Taskfile.yml 側にはコードがあるけどGitHub Action側が更新できていないので更新する必要がある。

doc/_toc.yml Outdated Show resolved Hide resolved
doc/references.bib Outdated Show resolved Hide resolved
doc/_config.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@termoshtt termoshtt left a comment

Choose a reason for hiding this comment

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

LGTM

@termoshtt termoshtt merged commit 07e55a1 into main Nov 27, 2024
28 checks passed
@termoshtt termoshtt deleted the jupyter-book branch November 27, 2024 06:53
@termoshtt termoshtt added the documentation Improvements or additions to documentation label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants