Fix pandoc missing error in nbsphinix setup

[kashish2210]

Update Documentation to Fix PandocMissing Error

Description

This PR updates docs/index.rst to include instructions for resolving the nbsphinx.NotebookError: PandocMissing error.

Changes Made

• Added troubleshooting steps in docs/index.rst for missing Pandoc issues.

Checklist

• [x] Follows project documentation standards.
• [x] Verified correctness of updated instructions.

preview

Notes

Let me know if any refinements are needed!

[ankitkhushwaha]

can u mention which issue this pr addresses?

[kashish2210]

I found this issue while I was making docs following the setup guides then resolved it for my computer then thought it would be good to write it down

On Mon, 3 Mar 2025, 20:18 Ankit Khushwaha, @.***> wrote:

can u mention which issue this pr addresses?

— Reply to this email directly, view it on GitHub https://github.com/StingraySoftware/stingray/pull/895#issuecomment-2694649658, or unsubscribe https://github.com/notifications/unsubscribe-auth/BEWH4H222RGSWTNAJHOLKP32SRTUZAVCNFSM6AAAAABYHETZM2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOJUGY2DSNRVHA . You are receiving this because you authored the thread.Message ID: @.***> [image: ankitkhushwaha]ankitkhushwaha left a comment (StingraySoftware/stingray#895) https://github.com/StingraySoftware/stingray/pull/895#issuecomment-2694649658

can u mention which issue this pr addresses?

— Reply to this email directly, view it on GitHub https://github.com/StingraySoftware/stingray/pull/895#issuecomment-2694649658, or unsubscribe https://github.com/notifications/unsubscribe-auth/BEWH4H222RGSWTNAJHOLKP32SRTUZAVCNFSM6AAAAABYHETZM2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOJUGY2DSNRVHA . You are receiving this because you authored the thread.Message ID: @.***>

[ankitkhushwaha]

@matteobachetti may give better review for this.

[matteobachetti]

@kashish2210 thanks for your PR. However, pandoc is among the required dependencies to build the documentation, so this should never happen, and I don't think setup.py is the correct place to put this information. You might instead think about adding something about installing the required dependencies in the documentation itself where users typically read how to install the software: https://docs.stingray.science/en/stable/#building-the-documentation

[kashish2210]

@matteobachetti Thank you for your feedback and clarification regarding the required dependencies. You're absolutely right—setup.py isn't the best place for this information.

I've now updated the documentation in docs/index.rst to include the necessary instructions for installing Pandoc, ensuring users can find the solution in the appropriate section. Additionally, while Pandoc is a required dependency, I encountered this error because Pandoc wasn’t set to my system’s PATH, which some users might also experience.