Skip to content

[DOC] add note to install pandoc #2489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TonyBagnall merged 1 commit into from
Jan 11, 2025
Merged

[DOC] add note to install pandoc #2489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/developer_guide/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,21 @@ pip install --editable .[docs]
cd docs
```

> **Note:** If you are using Linux or MacOS, you'll have to install [**Pandoc**](https://pandoc.org/) as a dependency. Install it using the following command:
>
> If you're using any Debian based system, you can use the following command to install Pandoc:
> ```bash
> sudo apt install pandoc
> ```
>
> If you're using MacOS, you can use the following command to install Pandoc:
> ```bash
> brew install pandoc
> ```
>
> For all other operating systems, please checkout the [Pandoc installation guide](https://pandoc.org/installing.html).
>

3. To build the website locally, run:

```powershell
Expand Down