Skip to content

fix(docs): generate notebooks before publishing - #22

Open
awais-ur-rehman wants to merge 1 commit into
symengine:sourcesfrom
awais-ur-rehman:feat/fix-notebook-publishing
Open

awais-ur-rehman wants to merge 1 commit into
symengine:sourcesfrom
awais-ur-rehman:feat/fix-notebook-publishing

Conversation

@awais-ur-rehman

Copy link
Copy Markdown

Summary

The notebook deployment points at ./notebooks, but the workflow never creates that directory, and the existing genNotebooks task fails because NBSITE is undefined. Define the output directory and run the task before deployment so the notebooks branch receives the converted tutorials.

Breaking changes

None.

Testing

  • Reproduced NameError: uninitialized constant NBSITE by invoking the existing genNotebooks task body.
  • Ran rake genNotebooks with Jupytext 1.19.6 and Rake 13.3.1; it generated all three existing Python/C++ notebooks under notebooks/use/api/.
  • Validated each output with nbformat.validate and compared every cell type and source with its MyST input.
  • Parsed the workflow and checked generation runs before notebook deployment and uses the same output directory.
  • To verify manually, run rake genNotebooks from the checkout and open notebooks/use/api/py/FirstPy.myst.ipynb in Jupyter.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant