Skip to content

Commit faa8237

Browse files
docs: update how-to page on building docs
1 parent 9d0957d commit faa8237

3 files changed

Lines changed: 5 additions & 1 deletion

File tree

‎docs/how-to/build-docs.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,12 @@ $ tox -e docs-autobuild -- --watch tests
4141
(building-docs-in-ci)=
4242
## Building docs in CI
4343

44+
Docs are built using the [myst-version-switcher-plugin](https://github.com/DiamondLightSource/myst-version-switcher-plugin).
45+
4446
After a successful run of CI
4547

4648
Settings > Pages
4749

48-
![Setup GitHub Pages](../images/gh-pages-setup.png)
50+
![Setup GitHub Pages](../images/github-pages-actions-setup.png)
51+
52+
If your repo was using the ```gh-pages``` branch to publish docs, follow the [migration instructions](https://diamondlightsource.github.io/myst-version-switcher-plugin/main/how-to/) to now use Github Actions.

‎docs/images/gh-pages-setup.png‎

-121 KB
Binary file not shown.
104 KB
Loading

0 commit comments

Comments
 (0)