Sphinx Needs is a Sphinx extension for managing requirements, specifications, and other 'needs' within documentation. It allows users to define, link, filter, and visualize needs directly in reStructuredText documents. The current version is 8.0.0, and it follows a regular release cadence with major updates typically every few months and patch releases as needed.
pip install sphinx-needsVerified import paths — ran on the pinned version, not inferred.
Add 'sphinx_needs' to the `extensions` list in your Sphinx project's `conf.py` file. Then, you can define needs using the `.. need::` directive in your reStructuredText (`.rst`) documents.
Ensure all custom `needs_extra_options`, `needs_statuses`, and `needs_tags` are correctly defined and comply with their respective schemas in `conf.py`. If migrating, consider temporarily setting `needs_schema_validation_enabled = False` (version 6.1.1+) to debug.
Update your `needs_global_options` definition in `conf.py` to the new dictionary-based format. Consult the official Sphinx-Needs documentation for the current structure.
Replace `extra_options_sum` with equivalent functionality using `dynamic_functions` in your `conf.py`.
Prioritize fixing schema errors over disabling validation. Only disable temporarily for migration or debugging purposes, and re-enable as soon as possible to maintain data integrity.
No dependency data recorded yet.