From 20979d92ae78439e9df5dfc59ed066ad8105c9e1 Mon Sep 17 00:00:00 2001 From: Lance Goyke Date: Sun, 19 Nov 2023 07:32:51 -0600 Subject: [PATCH] =?UTF-8?q?Add=20inline=20tabs=20on=20Helping=20with=20the?= =?UTF-8?q?=20Developer=E2=80=99s=20Guide=20page=20for=20commands=20on=20d?= =?UTF-8?q?ifferent=20systems=20(#1223)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documentation/devguide.rst | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/documentation/devguide.rst b/documentation/devguide.rst index b8d1de28d3..a17ed342a9 100644 --- a/documentation/devguide.rst +++ b/documentation/devguide.rst @@ -4,6 +4,14 @@ Helping with the Developer's Guide ================================== +.. raw:: html + + + .. highlight:: console The Developer's Guide (what you're reading now) uses the same process as the @@ -32,15 +40,21 @@ To build the devguide, some additional dependencies are required (most importantly, `Sphinx`_), and the standard way to install dependencies in Python projects is to create a virtualenv, and then install dependencies from a ``requirements.txt`` file. For your convenience, this is all *automated for -you*. To build the devguide on a Unix-like system use:: +you*. + +To build the devguide from the checkout directory: + +.. tab:: Unix/macOS + + .. code-block:: shell - $ make html + make html -in the checkout directory. On Windows use: +.. tab:: Windows -.. code-block:: doscon + .. code-block:: dosbatch - > .\make html + .\make html You will find the generated files in ``_build/html``.