Skip to content

Commit 0aee78d

Browse files
doc: installing pandoc added in contributing.md
1 parent 2219de6 commit 0aee78d

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

CONTRIBUTING.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ describing the problem you would like to solve.
1818

1919
### Setup your environment locally
2020

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,
2222
consider [installing it](https://github.com/cli/cli#installation), but you can
2323
always use the Web UI if you prefer that instead.
2424

@@ -41,6 +41,13 @@ etc... included), use pip:
4141
pip install -r requirements-dev.txt
4242
```
4343

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+
4451
The last (optinal) step is to setup a GitHub personal access tokens to enable
4552
the sphinx automatic changelog generation. This step is only important if you
4653
want to preview this changelog generation on your personal computer. Not being

Dockerfile

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ RUN pip3 install --upgrade pip && \
99

1010
FROM python:3.9
1111

12-
RUN apt-get update && \
13-
apt-get install -y pandoc && \
14-
apt-get clean && \
12+
RUN apt update && \
13+
apt install -y pandoc && \
14+
apt clean && \
1515
rm -rf /var/lib/apt/lists/*
1616

1717
WORKDIR /usr/src/app/mpqp

0 commit comments

Comments
 (0)