From 8cfdfd3f330701b924bc2c7e2c462c222f86e9aa Mon Sep 17 00:00:00 2001 From: Grey Li Date: Fri, 21 May 2021 16:34:23 +0800 Subject: [PATCH] Improve commands in the contributing docs --- CONTRIBUTING.rst | 38 +++++++++++++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3a9177a4..833e1eb3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -121,9 +121,26 @@ First time setup - Install the development dependencies, then install Flask in editable mode. - .. code-block:: text + .. tabs:: - $ pip install -r requirements/dev.txt && pip install -e . + .. group-tab:: Bash + + .. code-block:: text + + $ pip install -r requirements/dev.txt && pip install -e . + + .. group-tab:: CMD + + .. code-block:: text + + > pip install -r requirements/dev.txt && pip install -e . + + .. group-tab:: Powershell + + .. code-block:: text + + > pip install -r requirements/dev.txt + > pip install -e . - Install the pre-commit hooks. @@ -217,10 +234,21 @@ Building the docs Build the docs in the ``docs`` directory using Sphinx. -.. code-block:: text +.. tabs:: - $ cd docs - $ make html + .. group-tab:: Linux/macOS + + .. code-block:: text + + $ cd docs + $ make html + + .. group-tab:: Windows + + .. code-block:: text + + > cd docs + > .\make.bat html Open ``_build/html/index.html`` in your browser to view the docs.