Skip to content

Fix pandoc missing error in nbsphinix setup #895

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix pandoc missing error in nbsphinix setup #895

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
038649f
Fix pandoc missing error in nbsphinix setup
kashish2210 Mar 3, 2025
818f913
add note to index.rst/docs for pandoc error
kashish2210 Mar 3, 2025
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/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,21 @@ If that doesn't work on your system, you can invoke ``sphinx-build`` itself from
The documentation should be located in ``stingray/docs/_build``. Try opening ``./docs/_build/index.rst`` from
the stingray source directory.

**Note:**

If you see the error::

nbsphinx.NotebookError: PandocMissing

It means ``Pandoc`` is missing or not found.

Solution:

+ Install Pandoc from `pandoc.org <https://pandoc.org>`_ or `GitHub Releases <https://github.com/jgm/pandoc/releases/>`_.
+ Ensure Pandoc is in your system's PATH.
Copy link
Contributor

@ankitkhushwaha ankitkhushwaha Mar 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this is os(Window) specific , in linux we dont used to setup this.


After installation, restart your code editor and try again.

Using Stingray
===============

Expand Down