Skip to content

Add note about failure modes when using sphinx-build #3507

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.

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
merged 4 commits into from
Jun 25, 2025

Conversation

elide-b
Copy link
Contributor

@elide-b elide-b commented Jun 23, 2025

Running the documentation build from different working directories, or placing the build directory inside of the source directory causes strange failures (see below), which for most Sphinx builds is the default layout, so I've added a note to clarify that for the NEST doc build that is not a suitable option ✨

Notebook error:
CellExecutionError in _build/_downloads/0a77cecc347c93bf5d339ab292f0f3ad/eprop_supervised_classification_neuromorphic_mnist.ipynb:
------------------
pixels_blocklist = np.loadtxt("./NMNIST_pixels_blocklist.txt")

...

File ~/wsl-git/nest-simulator/.venv/lib/python3.12/site-packages/numpy/lib/_datasource.py:529, in DataSource.open(self, path, mode, encoding, newline)
    526     return _file_openers[ext](found, mode=mode,
    527                               encoding=encoding, newline=newline)
    528 else:
--> 529     raise FileNotFoundError(f"{path} not found.")

FileNotFoundError: ./NMNIST_pixels_blocklist.txt not found.

@jessica-mitchell jessica-mitchell self-requested a review June 24, 2025 09:07
@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Jun 24, 2025
@github-project-automation github-project-automation bot moved this to In progress in Documentation Jun 24, 2025
@jessica-mitchell jessica-mitchell changed the title Added note about failure modes when using sphinx-build Add note about failure modes when using sphinx-build Jun 24, 2025
Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

Great! thanks for adding this note @elide-b , I have a couple of suggestions for improvements :)

@github-project-automation github-project-automation bot moved this from In progress to Review in Documentation Jun 24, 2025
Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
@elide-b elide-b requested a review from jessica-mitchell June 24, 2025 10:32
Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

Thanks @elide-b lgtm

@jessica-mitchell
Copy link
Contributor

Merging with 1 reviewer as its documentation related

@jessica-mitchell jessica-mitchell merged commit e4cd817 into nest:master Jun 25, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from Review to Done in Documentation Jun 25, 2025
@elide-b elide-b deleted the doc-error-NMNIST_pixels branch June 25, 2025 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants