Skip to content

Add quarto based tutorials website deployed to gh pages with pixi#92

Open
jgunstone wants to merge 4 commits intowassimj:mainfrom
jgunstone:add-quarto-based-tutorials-website-deployed-to-gh-pages-with-pixi
Open

Add quarto based tutorials website deployed to gh pages with pixi#92
jgunstone wants to merge 4 commits intowassimj:mainfrom
jgunstone:add-quarto-based-tutorials-website-deployed-to-gh-pages-with-pixi

Conversation

@jgunstone
Copy link
Copy Markdown

Hi,

Sorry for the delay on this, I started a new job and generally became quite busy.
I've created a new branch and squashed the commits to do the following:

  • add a separate standalone pixi.toml file to set up a documentation environment inc. energyplus / openstudio
  • added a quarto project to the tutorials folder that builds the website
    • I copied over a handful of notebooks from the notebooks folder but it'd be straightforward to copy in more.
    • if you author pages with notebooks they do not automatically get executed at build time. see quarto execution options
    • if you author with .qmd files they will always execute. this is good for verifying they still run / catching errors.
  • added a .github/workflows/tutorials.yml workflow that builds website on push or PR to main (edit triggers as you see fit)
    • you'll need to enable the gh pages in the repo settings as I did in my fork to publish the built pages from the gh-pages branch that the output html gets saved to

thanks!

@jgunstone
Copy link
Copy Markdown
Author

hi @wassimj - have you had a chance to have a look at this?

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