[BUG] Pandoc installation missing in documentation build page

[inclinedadarsh]

Describe the issue

While following the Developer's guide for building documentation, after running the command make html, it gives the following error:

Notebook error:
PandocMissing in examples/anomaly_detection/anomaly_detection.ipynb:
Pandoc wasn't found.
Please check that pandoc is installed:
https://pandoc.org/installing.html
make: *** [Makefile:20: html] Error 2

Which suggests Pandoc is missing

Suggest a potential alternative/fix

Simply installing pandoc worked on my system.

A simple note regarding this in the Developer's guide for building documentation should work, but I believe there can be better solutions.

Additional context

I would be happy to work on this issue.

[baraline]

I think a simple fix would be to add pandoc as a dependency in the developer/documentation install options in the pyproject.toml.
I'm just wondering why we never had the issue before ? @MatthewMiddlehurst do we actually use this ? I'm not seeing it in the makefile or in docs.

[inclinedadarsh]

@baraline Pandoc is not a python dependency actually.

Sorry for not mentioning this in the original issue, but I had to fix it using sudo apt install pandoc.
I use Debian Bookwarm (12)

It might be just for my system, I'm not sure though.

I have mentioned the error logs in the original message, however, if you want, I can try rebuilding the docs in a different system and provide logs.

[baraline]

That would be great if you could, so we can know if it is OS related or not

[inclinedadarsh]

So I tried following the installation and documentation build steps on a fresh installation of Ubuntu (latest stable) (on wsl2) and I got the same error:

Notebook error:
PandocMissing in examples/anomaly_detection/anomaly_detection.ipynb:
Pandoc wasn't found.
Please check that pandoc is installed:
https://pandoc.org/installing.html
make: *** [Makefile:20: html] Error 2

I ran the following commands (in order):

python3 -m venv venv

pip install --editable .[dev]

pip install --editable .[docs]

cd docs

make html

After doing a bit of research, it turns out Pandoc can be installed via apt as well as via pip
So I ran the command pip install pandoc and then I ran make html and the build was still throwing the same error.

Finally, I tried installing pandoc via apt:

sudo apt install pandoc

This resulted in a successful build, and I was able to view all the build files.