Skip to content

Add preparation step for Jekyll deployment and include static files #4631

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.

Sign up for GitHub

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

Merged
shyuep merged 3 commits into from
Apr 11, 2026
Merged

Add preparation step for Jekyll deployment and include static files #4631

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b03dfe8
Add preparation step for Jekyll deployment and include static files
cogsworth37 Apr 10, 2026
b767d91
Update Jekyll deployment workflow to use UV for documentation generat…
cogsworth37 Apr 10, 2026
3750f4a
Moved the prepare step into the Generate Sphinx API docs step for con…
cogsworth37 Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/jekyll-gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ jobs:
- name: Setup Pages
uses: actions/configure-pages@v5

- name: Prepare docs for Jekyll
working-directory: docs
run: |
cp -r html/_static _static
touch .nojekyll
Copy link
Copy Markdown
Contributor

@DanielYang59 DanielYang59 Apr 10, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Curious what does .nojekyll do (as i don't have experience with jekyll at all)? I see here:

It is now possible to completely bypass Jekyll processing on GitHub Pages by creating a file named .nojekyll in the root of your pages repo and pushing it to GitHub.

But I think in the _config.yml there is already an explicit include: _static tag? does these two serve different purposes?

This should only be necessary if your site uses files or directories that start with underscores since Jekyll considers these to be special resources and does not copy them to the final site.

Copy link
Copy Markdown
Contributor Author

@cogsworth37 cogsworth37 Apr 10, 2026

Choose a reason for hiding this comment

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

It does not. it's an extra extra guard. I usually like to add protections in multiple places as long as it's functionally consistent. just a quirk of mine, happy to remove if you don't feel it's necessary.

Copy link
Copy Markdown
Contributor

@DanielYang59 DanielYang59 Apr 10, 2026

Choose a reason for hiding this comment

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

I guess we're not talking about security where we need layers of defense here... personally I think if one config gets the job done then we might not need to duplicate here (less confusion for later readers... people like me would think they're serving different purposes)


- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
Expand Down
5 changes: 4 additions & 1 deletion docs/_config.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading