-
-
Notifications
You must be signed in to change notification settings - Fork 207
ENH: switch to the mystmd enginery for rendering #274
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
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
6fcce17
ENH: adding myst config and toc
bsipocz d8fca0a
Removing toctrees and unused index files
bsipocz d3721ae
Switching the build engine
bsipocz ab9d00a
MAINT: adding to gitignore
bsipocz 4c6a32c
Attempt at fixing conda job.
rossbar 2ec2841
Spelling.
rossbar 6ab890f
Add tox, rm sphinx.
rossbar deb2344
CI: fixing conda job
bsipocz 09fe7d6
CI: rm conda job - to be updated with pixi later.
rossbar 9344931
CI: pass on the BASE_URL 🤦🤦♀️
bsipocz bc4cb6d
Adding GHA deployment for the rendered pages
bsipocz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,46 @@ | ||
| name: Build and Publish HTML and deployed_notebooks | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| schedule: | ||
| - cron: '0 5 * * 1' | ||
| workflow_dispatch: | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| env: | ||
| # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from. | ||
| # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`. | ||
| # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`. | ||
| BASE_URL: /${{ github.event.repository.name }} | ||
|
|
||
| jobs: | ||
|
|
||
| publish_html: | ||
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | ||
| name: Publish HTML | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v5 | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@v6 | ||
| with: | ||
| python-version: '3.12' | ||
|
|
||
| - name: Install dependencies | ||
| run: python -m pip install --upgrade tox | ||
|
|
||
| - name: Execute notebooks while building HTMLs | ||
| run: tox -e py312-buildhtml | ||
|
|
||
| - name: Publish | ||
| uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./_build/html/ | ||
| commit_message: ${{ github.event.head_commit.message }} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,7 @@ pmip | |
| tags | ||
| cscope.out | ||
| .ipynb_checkpoints | ||
| .tox | ||
|
|
||
| # Compiled source # | ||
| ################### | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| version: 1 | ||
| project: | ||
| title: Numpy Tutorials | ||
| # description: | ||
| # keywords: [] | ||
| authors: Numpy Community | ||
| github: https://github.com/numpy/numpy-tutorials | ||
| toc: | ||
| - file: site/index.md | ||
|
|
||
| - title: Applications | ||
| children: | ||
| - file: content/mooreslaw-tutorial.md | ||
| - file: content/tutorial-deep-learning-on-mnist.md | ||
| - file: content/tutorial-x-ray-image-processing.md | ||
| - file: content/tutorial-static_equilibrium.md | ||
| - file: content/tutorial-plotting-fractals.md | ||
| - file: content/tutorial-air-quality-analysis.md | ||
|
|
||
| - title: Features | ||
| children: | ||
| - file: content/tutorial-svd.md | ||
| - file: content/save-load-arrays.md | ||
| - file: content/tutorial-ma.md | ||
| - title: Contributing | ||
| file: site/contributing.md | ||
| children: | ||
| - file: content/tutorial-style-guide.md | ||
|
|
||
|
|
||
| site: | ||
| template: book-theme | ||
| options: | ||
| favicon: site/_static/favicon.png | ||
| logo: site/_static/numpylogo.svg |
This file was deleted.
Oops, something went wrong.
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1 @@ | ||
| sphinx | ||
| myst-nb | ||
| sphinx-book-theme | ||
| sphinx-copybutton | ||
| jupyter-book>=2 |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that the conda job has been removed this file is not being tested to work anywhere.
@rossbar - do you have preferences of how to progress?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would nuke the mentions of it, but again I wasn't the conda user. I would think we should provide an env that works ™️ and passes the test, but this one didn't so we may want to jump ships and recommend pixi anyways.
OTOH, I would block the merging of this on the condition that the launch in binder or somewhere else should work, so provide at least one way to users to try the content without mandating them to fix their local installs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I'd punt on it for now; i.e. leave the
environment.yml(untested) and work on switching to better tooling in followups.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, added it to the follow-up list (to be lifted into a separate issue)