From 1b758a3593814b57cf07d241456493bb1c1da069 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Tue, 25 Nov 2025 21:41:42 +0200 Subject: [PATCH] readme: use long options so it's more obvious what the option does --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index bc746f25..ec2403ee 100644 --- a/README.rst +++ b/README.rst @@ -69,17 +69,17 @@ You can build the rendered version by running:: By default, Sphinx uses incremental rebuilds to generate the content that changed since the last invocation. If you notice a problem with incremental -rebuilds, you can pass the ``-c`` flag to clear the existing artifacts before +rebuilds, you can pass the ``--clear`` flag to clear the existing artifacts before building:: - ./make.py -c + ./make.py --clear The rendered version will be available in ``build/html/``. You can also start a local server on port 8000 with automatic rebuild and reload -whenever you change a file by passing the ``-s`` flag:: +whenever you change a file by passing the ``--serve`` flag:: - ./make.py -s + ./make.py --serve Checking links consistency ==========================