From dafc2cdb6bc17df80b2e6fbe64c1ddf80a76ed2e Mon Sep 17 00:00:00 2001 From: Eli Schwartz Date: Tue, 25 Jan 2022 02:05:03 -0500 Subject: 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 --- docs/README.md | 4 ++-- 1 file 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 ``` -- cgit v1.1