Created
August 30, 2022 19:25
-
-
Save hamelsmu/9b5a59a5d1ca623790896e907ac84abe to your computer and use it in GitHub Desktop.
How docs workflow works
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
{ | |
"cells": [ | |
{ | |
"cell_type": "code", | |
"execution_count": null, | |
"id": "11e9d011-c7c0-4dca-9e6b-db3fbf730993", | |
"metadata": {}, | |
"outputs": [], | |
"source": [] | |
}, | |
{ | |
"cell_type": "markdown", | |
"id": "ed3cff02-5b2f-4878-bf85-3dee20d348bb", | |
"metadata": {}, | |
"source": [ | |
"#### Docs Workflows\n", | |
"\n", | |
"Whenever you change any of the content in your repo, the following workflows will run to generate a docs site (in this order):\n", | |
"\n", | |
"1. `Deploy to GitHub Pages`: This workflow builds the docs with nbdev.\n", | |
"2. `pages build and deployment`: This is a built-in workflow that GitHub provides that deploys the site to GitHub Pages. \n", | |
"\n", | |
"Should anything go wrong in your page build, you can always look at the logs of these workflows. Like other workflows, these can be found in the Actions tab of your repo:" | |
] | |
}, | |
{ | |
"cell_type": "markdown", | |
"id": "cff9bf9f-3728-4b20-93df-609a38a88328", | |
"metadata": {}, | |
"source": [ | |
"{fig-align=\"center\" .border .rounded .shadow-sm}" | |
] | |
} | |
], | |
"metadata": { | |
"kernelspec": { | |
"display_name": "Python 3 (ipykernel)", | |
"language": "python", | |
"name": "python3" | |
} | |
}, | |
"nbformat": 4, | |
"nbformat_minor": 5 | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment