Skip to content

Commit 1a9be47

Browse files
authored
Rename update_docs.py -> update_website.py (#26829)
This seems to better script what this script does.
1 parent 8eb2804 commit 1a9be47

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

.github/workflows/update-website.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ jobs:
3535
set -o xtrace
3636
git config --global user.name emscripten-bot
3737
git config --global user.email emscripten-bot@users.noreply.github.com
38-
if ./tools/maint/update_docs.py; then
39-
echo "update_docs.py returned zero, expectations up-to-date"
38+
if ./tools/maint/update_website.py; then
39+
echo "update_website.py returned zero, expectations up-to-date"
4040
# Exit early and don't create a PR
4141
exit 0
4242
else
4343
code=$?
4444
if [[ $code != 2 ]] ; then
45-
echo "update_docs.py failed with unexpected error $code (expected 2)"
45+
echo "update_website.py failed with unexpected error $code (expected 2)"
4646
exit 1
4747
fi
4848
fi

docs/process.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ normally be necessary.
196196

197197
If for some reason you need to update the `emscripten-site` repository manually
198198
there is a script that will perform the update steps:
199-
[`tools/maint/update_docs.py`][update_docs]. Run this script with no
199+
[`tools/maint/update_website.py`][update_website]. Run this script with no
200200
arguments if the `emscripten-site` repository is checked out alongside emscripten
201201
itself, or pass the location of the checkout if not.
202202

@@ -208,7 +208,7 @@ need to add `~/.local/bin` to your path, if pip installs to there).
208208
### Building and viewing the Website locally
209209

210210
To build the site locally for testing purposes you only need a subset of the
211-
`update_docs.py` command just mentioned above. Specifically:
211+
`update_website.py` command just mentioned above. Specifically:
212212

213213
1. Run `pip3` to install python dependencies, as described above.
214214
2. Run `make -C site html`.
@@ -381,7 +381,7 @@ decide collectively to abandon the deprecation, or to delay it.
381381
[clang-format]: https://github.com/emscripten-core/emscripten/blob/main/.clang-format
382382
[pyproject.toml]: https://github.com/emscripten-core/emscripten/blob/main/pyproject.toml
383383
[mypy]: https://github.com/emscripten-core/emscripten/blob/main/.mypy
384-
[update_docs]: https://github.com/emscripten-core/emscripten/blob/main/tools/maint/update_docs.py
384+
[update_website]: https://github.com/emscripten-core/emscripten/blob/main/tools/maint/update_website.py
385385
[llvm_repo]: https://github.com/llvm/llvm-project
386386
[llvm_emscripten_fork]: https://github.com/emscripten-core/llvm-project
387387
[push_llvm_changes_emscripten]: https://github.com/emscripten-core/emscripten/blob/main/system/lib/push_llvm_changes.py
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
message_template = '''\
2323
Automatic update of the emscripten website
2424
25-
This is an automated change generated by `tools/maint/update_docs.py` in the emscripten repo.
25+
This is an automated change generated by `tools/maint/update_website.py` in the emscripten repo.
2626
2727
The change was generated at git revision https://github.com/emscripten-core/emscripten/commit/%s
2828
'''

0 commit comments

Comments
 (0)