diff options
| author | Eli Schwartz <eschwartz@archlinux.org> | 2022-01-25 02:05:03 -0500 |
|---|---|---|
| committer | Eli Schwartz <eschwartz@archlinux.org> | 2022-01-25 02:05:03 -0500 |
| commit | dafc2cdb6bc17df80b2e6fbe64c1ddf80a76ed2e (patch) | |
| tree | 7ef8f1c969d472d86422af00ac300cf07f45470d /docs | |
| parent | a038fa80f5a4f6954fe3c0b39c8602c78a7898a2 (diff) | |
| download | meson-dafc2cdb6bc17df80b2e6fbe64c1ddf80a76ed2e.zip meson-dafc2cdb6bc17df80b2e6fbe64c1ddf80a76ed2e.tar.gz meson-dafc2cdb6bc17df80b2e6fbe64c1ddf80a76ed2e.tar.bz2 | |
docs: fix bad advice in the README
Do not recommend running the 'upload' target by default in order to
build the docs. That will fail with permission errors when trying to
push to a repo most people don't have commit access to, and if they did
have commit access it would be an even worse problem -- unpredictably
overwriting the main website without any guarantee it was generated from
the latest version of the docs!
Plus, it does not actually work. The first thing it does is spawn an
error message that required files do not exist, because the actual docs
were not, in fact, built. So they cannot be uploaded either.
The docs will build by default if you do not specify a non-default
target.
Fixes #9873
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md index 55fc3ec..3a2626b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,8 +13,8 @@ Instructions on how to install hotdoc are [here](https://hotdoc.github.io/instal From the Meson repository root dir: ``` $ cd docs/ -$ meson built_docs -$ ninja -C built_docs/ upload +$ meson setup built_docs/ +$ ninja -C built_docs/ ``` Now you should be able to open the documentation locally ``` |