Skip to content

Commit

Permalink
Tabify make / make.bat section
Browse files Browse the repository at this point in the history
  • Loading branch information
lancegoyke committed Nov 20, 2023
1 parent cab244e commit 937bfcc
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions documentation/start-documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,17 +116,22 @@ You can create a new :mod:`venv` with the required dependencies using:
Build using make / make.bat
---------------------------

A Unix ``Makefile`` is provided, :cpy-file:`Doc/Makefile`,
along with a :cpy-file:`Doc/make.bat` batch file for Windows
that attempts to emulate it as closely as practical.
.. tab:: Unix/macOS

A Unix ``Makefile`` is provided, :cpy-file:`Doc/Makefile`.

.. tab:: Windows

A Windows ``make.bat`` is provided, :cpy-file:`Doc/make.bat`, which
attempts to emulate the Unix ``Makefile`` as closely as practical.

.. important::
.. important::

The Windows ``make.bat`` batch file lacks a ``make venv`` target.
Instead, it automatically installs any missing dependencies
into the currently activated environment (or the base Python, if none).
Make sure the environment you :ref:`created above <doc-create-venv-windows>`
is `activated <venv-activate_>`__ before running ``make.bat``.
The Windows ``make.bat`` batch file lacks a ``make venv`` target.
Instead, it automatically installs any missing dependencies
into the currently activated environment (or the base Python, if none).
Make sure the environment you :ref:`created above <doc-create-venv-windows>`
is `activated <venv-activate_>`__ before running ``make.bat``.

To build the docs as HTML, run:

Expand Down

0 comments on commit 937bfcc

Please sign in to comment.