Skip to content

Commit 8e1a32e

Browse files
committed
Update Windows installation in the docs
1 parent e9c745c commit 8e1a32e

File tree

3 files changed

+13
-14
lines changed

3 files changed

+13
-14
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
# Add any paths that contain custom static files (such as style sheets) here,
9999
# relative to this directory. They are copied after the builtin static files,
100100
# so a file named "default.css" will overwrite the builtin "default.css".
101-
html_static_path = ["_static"]
101+
# html_static_path = ["_static"]
102102

103103

104104
# -- Options for HTMLHelp output ------------------------------------------

docs/installation.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can install itzi with pip or pipx.
1919
However, we recommend you use `uv <https://docs.astral.sh/uv>`__.
2020
Install *uv* by following the instructions on the `uv website <https://docs.astral.sh/uv>`__.
2121

22-
Once you have *uv* installed, you can install Itzï with the following command:
22+
Once you have *uv* installed, you can install Itzï with the following command::
2323

2424
uv tool install itzi
2525

@@ -28,9 +28,8 @@ This will automatically download itzi and install it in its own python environme
2828
Installation on Windows
2929
-------------------------
3030

31-
Itzï should be able to run on Windows using the Windows Subsystem for Linux (WSL).
32-
To install WSL, follow the steps given by `Microsoft <https://learn.microsoft.com/en-gb/windows/wsl/install>`__.
33-
Once a GNU/Linux distribution is installed, the installation steps for itzi are the same as above.
31+
Itzï has been tested on Windows 11.
32+
From a PowerShell terminal, the steps to install Itzï are the same as for GNU/Linux: first install *uv* then itzi.
3433

3534
Verification of the installation
3635
--------------------------------

docs/prog_manual.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ alongside the dependencies with:
3030

3131
.. code:: sh
3232
33-
$ pdm install
33+
pdm install
3434
3535
This will create a virtual environment and install all the dependencies listed in the *pyproject.toml* file.
3636
Now, every change you make to the Python code will be directly reflected when running *itzi* from the command line or the tests.
@@ -40,7 +40,7 @@ If so, install `uv <https://docs.astral.sh/uv/>`__ and set pdm to use it:
4040

4141
.. code:: sh
4242
43-
$ pdm config use_uv true
43+
pdm config use_uv true
4444
4545
4646
Cython code
@@ -52,8 +52,8 @@ you can do so by running the following command in the root directory of the repo
5252

5353
.. code:: sh
5454
55-
$ cython -3 src/itzi/flow.pyx
56-
$ pdm install
55+
cython -3 src/itzi/flow.pyx
56+
pdm install
5757
5858
5959
Testing
@@ -65,13 +65,13 @@ the tests must be run in separate processes using *pytest-forked*.
6565

6666
.. code:: sh
6767
68-
$ pdm run pytest --forked -v
68+
pdm run pytest --forked -v
6969
7070
To estimate the test coverage:
7171

7272
.. code:: sh
7373
74-
$ pdm run pytest --cov=itzi --forked -v
74+
pdm run pytest --cov=itzi --forked -v
7575
7676
Select the python version to test against with *pdm use*.
7777
Test against the 3 `last versions of python <https://devguide.python.org/versions/>`__.
@@ -96,12 +96,12 @@ Then you can build the documentation locally:
9696

9797
.. code:: sh
9898
99-
$ cd docs
100-
$ sphinx-build . _build
99+
cd docs
100+
sphinx-build . _build
101101
102102
103103
Continuous integration
104-
----------------
104+
----------------------
105105

106106
Tests are automatically run with GitHub Actions.
107107
Before committing changes to the workflows, test them locally using `act <https://nektosact.com/>`__.

0 commit comments

Comments
 (0)