-
Notifications
You must be signed in to change notification settings - Fork 789
Add a workflow to generate folder images #1533
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
Conversation
This workflow will generate a bunch of images and place them on a branch called "folder-images", which (once enabled via github pages) will appear on adafruit.github.io. The workflow is triggered: * on commits to the main branch, including merged pull requests * daily, after the bundle is updated * on request via the github web page Typically, this means that the images will be available (well) within an hour after a pull request is merged, and will be updated daily if required by changes to the requirements of libraries.
lets see what happens next! |
please make the path include subfolders since some folders have multiple code exmaples in them, @kattni wrote some recently |
@ladyada you mean have it show the contents of the subfolders in the images? |
nono like sometimes there are multiple subfolders with code.py in them, like |
Ah I see. it will make to images:
each one showing the libraries for the code.py that is inside of its folder. |
oh ok it does that now? gr8 |
No, sorry, I meant that is how we want it to behave. I will work on making that change though. I think I can make it work like that. |
oh ha - yah sorry thats right! |
@ladyada this has now been added |
ok yay |
This workflow will generate a bunch of images and place them on a branch called "folder-images", which (once enabled via github pages) will appear on adafruit.github.io.
The workflow is triggered:
Typically, this means that the images will be available (well) within an hour after a pull request is merged, and will be updated daily if required by changes to the requirements of libraries.
There is an HTML index by name, to make it "easier" to find the relevant image.
Here is the site generated under my personal github pages: http://www.unpythonic.net/Adafruit_Learning_System_Guides/
Index:

Typical image (from http://www.unpythonic.net/Adafruit_Learning_System_Guides/BLE_Client_Server.png):