Introduction¶
Bringing Engineering-as-Code to the Sphinx framework.
Combine Docs-as-Code with Application Lifecycle Management, to track requirements, specifications, test cases, and other engineering objects in your documentation.
Extensive configuration options allow you to adapt the extension to your specific needs, and the built-in API allows other extensions to extend sphinx-needs for specific solutions.
Dynamic functions allow you to handle complex data chains between needs, to load and set changeable data automatically during the documentation generation phase.
Allows for the creation of specific objects for architecture elements, which can be reused and recombined in different flow diagrams and higher architecture elements, using PlantUML.
See more from useblocks to enhance your sphinx-needs experience:
Provides an oversight of the useblocks ecosystem, and its goal to bring Engineering-as-Code to the software development process.
Provides a Bazel domain in Sphinx documentation and allows the automated import of Bazel files and their documentation.
Extension to collect or generate files from different sources and include them in the Sphinx source folder.
It supports sources like Git repositories, Jinja based files or symlinks.
Extension to import test results from XML files as need objects.
Created need objects can be filtered and linked to specification objects.