Skip to content

Commit e42e640

Browse files
authored
Update docs on website maintenance (#26675)
1 parent d927214 commit e42e640

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/process.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,14 +158,22 @@ How:
158158

159159
## Updating the `emscripten.org` Website
160160

161-
The site is currently hosted in `gh-pages` branch of the separate [site
162-
repository][site_repo]. To update the docs, rebuild them and copy them into
163-
this repository. There is a script that will perform these steps automatically:
164-
[`tools/maint/update_docs.py`][update_docs]. Just run this script with no
165-
arguments if the emscripten-site repository is checked out alongside emscripten
161+
The `emscripten.org` site is maintained in the `site/source` directory. It is
162+
written in reStructuredText and maintained using the Sphinx tool.
163+
164+
The site is hosted in the `gh-pages` branch of the separate [site
165+
repository][site_repo]. There is a CI job which runs on the `main` branch that
166+
will automatically update the `gh-pages` branch whenever the generated site
167+
contents change so checking out the `emscripten-site` repository should not
168+
normally be necessary.
169+
170+
If for some reason you need to update the `emscripten-site` repository manually
171+
there is a script that will perform the update steps:
172+
[`tools/maint/update_docs.py`][update_docs]. Run this script with no
173+
arguments if the `emscripten-site` repository is checked out alongside emscripten
166174
itself, or pass the location of the checkout if not.
167175

168-
You will need the specific sphinx version installed, which you can do using
176+
You will need the specific Sphinx version installed, which you can get by running
169177
`pip3 install -r requirements-dev.txt` (depending on your system, you may then
170178
need to add `~/.local/bin` to your path, if pip installs to there).
171179

0 commit comments

Comments
 (0)