Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #273
Motivation
Sphinx was unable to autodoc the
neuromancerpackage becausedocs/conf.pypointedsys.pathat../neuromancer(a subdirectory that doesn't exist at that path), causing modules to silently fail to import and rendering documentation pages empty.Changes
docs/conf.py, line 15: Updatedsys.path.insertto point at../srcinstead of../neuromancer, matching the actual package layout where theneuromancersource lives undersrc/neuromancer/.Testing
cd docs && make html— all previously empty pages (e.g.dynamics.html, and others generated fromsrc/neuromancer/) now render with full API content.WARNING: autodoc: failed to import moduleerrors in the build output after the fix._build/html/dynamics.htmlcontains populated class and function documentation rather than an empty body.This PR was created with AI assistance (Claude). The changes were reviewed by quality gates and a critic model before submission.