You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/guides/contributing.rst
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,10 @@ Setup a `Python virtual environment <https://docs.python.org/3/tutorial/venv.htm
32
32
# Create virtual environment (the second `venv` is the name of the folder of the virtual environment)
33
33
python3 -m venv venv
34
34
35
-
# Activate it
35
+
# On Windows, activate with:
36
+
venv\Scripts\activate.bat
37
+
38
+
# On Linux, activate with:
36
39
source venv/bin/activate
37
40
38
41
Install the Python packages necessary to build the docs
@@ -41,14 +44,14 @@ Install the Python packages necessary to build the docs
41
44
42
45
pip install -r docs/requirements.txt
43
46
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.
45
48
46
49
.. code:: bash
47
50
48
51
cd docs/
49
-
make html
52
+
sphinx-build -M htmlsource build
50
53
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.
0 commit comments