Skip to content

Commit 2ed4a43

Browse files
Add Windows instructions (#57)
1 parent d278d76 commit 2ed4a43

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/source/guides/contributing.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,10 @@ Setup a `Python virtual environment <https://docs.python.org/3/tutorial/venv.htm
3232
# Create virtual environment (the second `venv` is the name of the folder of the virtual environment)
3333
python3 -m venv venv
3434
35-
# Activate it
35+
# On Windows, activate with:
36+
venv\Scripts\activate.bat
37+
38+
# On Linux, activate with:
3639
source venv/bin/activate
3740
3841
Install the Python packages necessary to build the docs
@@ -41,14 +44,14 @@ Install the Python packages necessary to build the docs
4144
4245
pip install -r docs/requirements.txt
4346
44-
Finally to actually build the docs, go to the ``docs/`` directory and run `make html`, i.e.
47+
Finally to actually build the docs, go to the ``docs/`` directory and ``sphinx-build -M html source build``, i.e.
4548

4649
.. code:: bash
4750
4851
cd docs/
49-
make html
52+
sphinx-build -M html source build
5053
51-
This will create a new folder inside ``docs/`` called ``build/`` where under ``html/`` you can find the rendered HTML files which you can open in the browser of your choice.
54+
This will create a new folder inside ``docs/`` called ``build/`` where under ``html/`` you can find the rendered HTML files where built based from the ``.rst`` files located in ``source``. You can open the files in a browser of your choice to see what the edited page will look like.
5255

5356

5457
Tips and tricks

0 commit comments

Comments
 (0)