generated from VectorInstitute/aieng-template-poetry
-
Notifications
You must be signed in to change notification settings - Fork 16
Migrate from poetry to uv, sphinx to mkdocs #474
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
Open
amrit110
wants to merge
22
commits into
main
Choose a base branch
from
migrate-to-uv
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
c581422
Migrate from poetry to uv, sphinx to mkdocs
amrit110 1770468
Fixes to markdown, indents and type hints
amrit110 98000bb
Ignores to keras based CVEs
amrit110 26e434c
Fixing some docs rendering issues.
emersodb b362260
More docs rendering fixes
emersodb 47e12fb
More docs rendering fixes
emersodb 43446f3
More docs rendering fixes
emersodb 23c2295
More docs rendering fixes
emersodb 3ec1482
More docs rendering fixes
emersodb 59d49ae
More docs rendering fixes
emersodb 5f63951
More docs rendering fixes
emersodb 8f3575c
Merge branch 'main' into migrate-to-uv
amrit110 f89bfd3
Fix references to old poetry based instructions
amrit110 9058cbb
Additional fixes, add image assets
amrit110 f0d4764
Add logo file
amrit110 10db2c8
Fixes to math syntax
amrit110 4e7f62a
Fix line length
amrit110 5c1db9b
Fix and adjust smoke tests
amrit110 8875a7d
Update feddg_ga expected metrics for new package versions
amrit110 df107ae
Fix non-determinism in feddg_ga test by seeding DirichletLabelBasedSa…
amrit110 7e97042
Fix smoke tests
amrit110 3422881
Change ubuntu version to latest
amrit110 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| name: docs | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - .pre-commit-config.yaml | ||
| - .github/workflows/docs.yml | ||
| - '**.py' | ||
| - '**.ipynb' | ||
| - '**.html' | ||
| - '**.js' | ||
| - '**.md' | ||
| - '**.rst' | ||
| - uv.lock | ||
| - pyproject.toml | ||
| - mkdocs.yml | ||
| - '**.png' | ||
| - '**.svg' | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - .pre-commit-config.yaml | ||
| - .github/workflows/docs.yml | ||
| - '**.py' | ||
| - '**.ipynb' | ||
| - '**.js' | ||
| - '**.html' | ||
| - uv.lock | ||
| - pyproject.toml | ||
| - '**.md' | ||
| - '**.rst' | ||
| - mkdocs.yml | ||
| - '**.png' | ||
| - '**.svg' | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Install uv | ||
| uses: astral-sh/setup-uv@v7.1.5 | ||
| with: | ||
| version: "0.9.11" | ||
| enable-cache: true | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v6.1.0 | ||
| with: | ||
| python-version-file: ".python-version" | ||
|
|
||
| - name: Set up cache | ||
| uses: actions/cache@v5 | ||
| id: cached-uv-dependencies | ||
| with: | ||
| path: .venv | ||
| key: venv-${{ runner.os }}-${{ hashFiles('**/uv.lock') }} | ||
|
|
||
| - name: Install the project | ||
| run: uv sync --group docs --group test | ||
|
|
||
| - name: Build docs | ||
| run: uv run mkdocs build | ||
|
|
||
| - name: Create .nojekyll file | ||
| run: touch site/.nojekyll | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-artifact@v5 | ||
| with: | ||
| name: docs-site | ||
| path: site/ | ||
| retention-days: 1 | ||
|
|
||
| deploy: | ||
| needs: build | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Configure Git Credentials | ||
| run: | | ||
| git config user.name github-actions[bot] | ||
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | ||
|
|
||
| - name: Download artifact | ||
| uses: actions/download-artifact@v6 | ||
| with: | ||
| name: docs-site | ||
| path: site | ||
|
|
||
| - name: Ensure .nojekyll exists | ||
| run: touch site/.nojekyll | ||
|
|
||
| - name: Deploy to Github pages | ||
| uses: JamesIves/github-pages-deploy-action@v4.7.6 | ||
| with: | ||
| branch: github_pages | ||
| folder: site |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.