From 5e6da0af5a06f051bf7b42934c4ee94dde652c51 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sat, 12 Oct 2024 19:06:08 +0100 Subject: [PATCH] tweaks --- doc/internals/contributing.rst | 6 +++--- doc/usage/quickstart.rst | 11 ++++++----- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/internals/contributing.rst b/doc/internals/contributing.rst index 3d77cb11d47..de68cbf1dec 100644 --- a/doc/internals/contributing.rst +++ b/doc/internals/contributing.rst @@ -270,14 +270,14 @@ you to preview in :file:`build/sphinx/html`. You can also build a **live version of the documentation** that you can preview in the browser. It will detect changes and reload the page any time you make -edits. To do so, use `sphinx-autobuild -`_ to run the following -command: +edits. +To do so, use `sphinx-autobuild`_ to run the following command: .. code-block:: shell sphinx-autobuild ./doc ./build/sphinx/ +.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild Translations ~~~~~~~~~~~~ diff --git a/doc/usage/quickstart.rst b/doc/usage/quickstart.rst index 1b8231d369a..062c92e966c 100644 --- a/doc/usage/quickstart.rst +++ b/doc/usage/quickstart.rst @@ -149,14 +149,15 @@ Sphinx will build HTML files. for all options that :program:`sphinx-build` supports. You can also build a **live version of the documentation** that you can preview -in the browser. It will detect changes and reload the page any time you make -edits. To do so, use `sphinx-autobuild -`_ to run the following -command: +in the browser. +It will detect changes and reload the page any time you make edits. +To do so, use `sphinx-autobuild`_ to run the following command: .. code-block:: console - $ sphinx-autobuild sourcedir outputdir + $ sphinx-autobuild source-dir output-dir + +.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a :file:`make.bat` which make life even easier for you. These can be executed by