From c0e937a3b4f809ea20691d77ed26b1ce44b5c040 Mon Sep 17 00:00:00 2001 From: Joas Schilling <213943+nickvergessen@users.noreply.github.com> Date: Wed, 8 Mar 2023 11:25:39 +0100 Subject: [PATCH] Update README.rst Signed-off-by: Joas Schilling <213943+nickvergessen@users.noreply.github.com> --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index ab35747f6..5707f686b 100644 --- a/README.rst +++ b/README.rst @@ -115,9 +115,9 @@ Building HTML 4. Install the dependencies ``pip install -r requirements.txt`` 5. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals -To change into this environment you need to run `pipenv shell` to launch the shell and to exit you can use either ``exit`` or ``Ctrl`` + ``D``. +To change into this environment you need to run ``pipenv shell`` to launch the shell and to exit you can use either ``exit`` or ``Ctrl`` + ``D``. -When editing the documentation installing `sphinx-autobuild` though pip can be helpful. This will watch file changes and automatically reload the html preview: +When editing the documentation installing ``sphinx-autobuild`` though pip can be helpful. This will watch file changes and automatically reload the html preview: 1. Install ``pip install sphinx-autobuild`` 2. Enter the documentation section ``cd user_manual``