needs-config-writer

Sphinx-Needs can be fully configured via conf.py, but can also load configuration from a ubproject.toml file. This file can be created and updated automatically via the needs-config-writer Sphinx extension.

Many Sphinx projects want to generate a part of the Sphinx-Needs configuration automatically. Tools like ubCode / ubc require a declarative format to ingest configuration. This extension tries to bridge the gap between Sphinx’s dynamic Python configuration and the need for a static configuration file.

Contents

• Configuration
  • needscfg_outpath
  • needscfg_warn_on_diff
  • needscfg_overwrite
  • needscfg_write_all
  • Examples
• Behavior
  • Configuration Export Process
  • Type Handling
  • Sorting for Reproducibility
  • File Lifecycle
  • Warnings and Logging

Development

• Changelog
• Contributing