From 8581d355d6250b27ca9d8708d7c206f66cee73e4 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 2 Jul 2024 21:38:28 -0700 Subject: [PATCH] Use code blocks instead of inline --- docs/install.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 5bb46078..517d0a57 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -132,10 +132,20 @@ To build the documentation, follow these steps: You can now open the output from ``_build/html/index.html``. -To build the documentation, view it in a web browser, and automatically reload changes while you edit documentation, use ``make livehtml`` instead of ``make html``. +To build the documentation, view it in a web browser, and automatically reload changes while you edit documentation, use the following command. + +.. code-block:: shell + + make livehtml + Then open a web browser at `http://127.0.0.1:8050 `_. -To build the presentation-version use ``make presentation`` instead of ``make html``. +To build the presentation-version use the following command. + +.. code-block:: shell + + make presentation + You can open the presentation at ``presentation/index.html``. You can also use ``tox`` to build the documentation: