Skip to content

Fix #273: document pages empty#281

Open
JiwaniZakir wants to merge 1 commit intopnnl:masterfrom
JiwaniZakir:fix/273-document-pages-empty
Open

Fix #273: document pages empty#281
JiwaniZakir wants to merge 1 commit intopnnl:masterfrom
JiwaniZakir:fix/273-document-pages-empty

Conversation

@JiwaniZakir
Copy link
Copy Markdown

Closes #273

Motivation

Sphinx was unable to autodoc the neuromancer package because docs/conf.py pointed sys.path at ../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: Updated sys.path.insert to point at ../src instead of ../neuromancer, matching the actual package layout where the neuromancer source lives under src/neuromancer/.

# Before
sys.path.insert(0, os.path.abspath('../neuromancer'))

# After
sys.path.insert(0, os.path.abspath('../src'))

Testing

  1. Built docs locally with cd docs && make html — all previously empty pages (e.g. dynamics.html, and others generated from src/neuromancer/) now render with full API content.
  2. Confirmed no Sphinx WARNING: autodoc: failed to import module errors in the build output after the fix.
  3. Verified the built _build/html/dynamics.html contains 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

document pages empty

1 participant