@@ -18,7 +18,7 @@ describing the problem you would like to solve.
18
18
19
19
### Setup your environment locally
20
20
21
- _ Some commands will assume you have the GitHub CLI installed, if you haven't,
21
+ \ _ Some commands will assume you have the GitHub CLI installed, if you haven't,
22
22
consider [ installing it] ( https://github.com/cli/cli#installation ) , but you can
23
23
always use the Web UI if you prefer that instead.
24
24
@@ -41,6 +41,13 @@ etc... included), use pip:
41
41
pip install -r requirements-dev.txt
42
42
```
43
43
44
+ In the documentation, some notebooks are rendered to HTML, this process is done
45
+ using [ Pandoc] ( https://pandoc.org/ ) . Unfortunately, this software cannot be
46
+ installed from the pip repository, so you need to install it separately. You can
47
+ check [ their documentation] ( https://pandoc.org/installing.html ) to see how to
48
+ install it on your OS (you can find it on most package manager: ` apt ` ,
49
+ ` yum ` , ` pacman ` , ` choco ` , ` winget ` , ` brew ` and more... )
50
+
44
51
The last (optinal) step is to setup a GitHub personal access tokens to enable
45
52
the sphinx automatic changelog generation. This step is only important if you
46
53
want to preview this changelog generation on your personal computer. Not being
0 commit comments