orbit-oss/flask
4
5
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve commands in the contributing docs

Browse source
This commit is contained in:
Grey Li 2021-05-21 16:34:23 +08:00
parent e22021d531
commit 8cfdfd3f33
1 changed files with 33 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

30
CONTRIBUTING.rst
View file

@ -121,10 +121,27 @@ First time setup
- Install the development dependencies, then install Flask in editable - Install the development dependencies, then install Flask in editable
mode. mode.
.. tabs::
.. group-tab:: Bash
.. code-block:: text .. code-block:: text
$ pip install -r requirements/dev.txt && pip install -e . $ 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. - Install the pre-commit hooks.
.. code-block:: text .. code-block:: text
@ -217,11 +234,22 @@ Building the docs
Build the docs in the ``docs`` directory using Sphinx. Build the docs in the ``docs`` directory using Sphinx.
.. code-block:: text .. tabs::
.. group-tab:: Linux/macOS
.. code-block:: text
$ cd docs $ cd docs
$ make html $ 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. Open ``_build/html/index.html`` in your browser to view the docs.
Read more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__. Read more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.