@@ -11,34 +11,53 @@ is served using [GitHub Pages](https://pages.github.com/).
1111Follow < https://squidfunk.github.io/mkdocs-material/getting-started/ > and read
1212< https://www.mkdocs.org/ > .
1313
14- All steps below are from this docs/website/ folder.
14+ All steps below are from this ` docs/website/ ` folder.
1515
16- Setup ( as needed) :
16+ ** Setup** as needed:
1717
1818``` shell
1919python3 -m venv .venv
2020source .venv/bin/activate
2121pip install -r requirements.txt
2222```
2323
24- Develop:
24+ ** Develop** by building and running a local webserver :
2525
2626``` shell
27- ./generate_extra_files.sh
27+ # Optionally generate extra files, e.g. MLIR dialect pages produced by tablegen
28+ # The website will still work without these pages.
29+ # ./generate_extra_files.sh
30+
2831mkdocs serve
2932```
3033
31- Deploy:
34+ ### Deploying the documentation
35+
36+ The
37+ [ ` publish_website.yml ` ] ( https://github.com/iree-org/iree/actions/workflows/publish_website.yml )
38+ workflow in < https://github.com/iree-org/iree > builds the website and deploys
39+ it automatically.
40+
41+ If you want to host the documentation on your own GitHub Pages site, such as to
42+ allow code reviewers to preview your changes, you can deploy the documentation
43+ yourself.
3244
33- * This force pushes to ` gh-pages ` on ` <your remote> ` . Please don't push to the
34- main repository :)
35- * The ` publish_website.yml ` workflow takes care of publishing from the central
36- repository automatically
45+ > [ !IMPORTANT]
46+ > If you are just previewing changes locally, you don't need this!
47+ >
48+ > This force pushes to the ` gh-pages ` branch on ` <your remote> ` . Please don't
49+ > push to the main < https://github.com/iree-org/iree > repository :)
50+
51+ To deploy to a remote:
3752
3853``` shell
3954mkdocs gh-deploy --remote-name < your remote>
4055```
4156
57+ Assuming you have GitHub Pages configured for your remote from the ` gh-pages `
58+ branch (see ` https://github.com/<your remote>/iree/settings/pages ` ), the
59+ website should be live shortly at ` https://<your remote>.github.io/iree ` .
60+
4261## Website sections and authoring tips
4362
4463For more details on how this is set up, see
0 commit comments