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.


Adaptable to your needs

An extension for the Python based Sphinx documentation framework, enabling you to define, link, and analyse engineering objects within your documentation, specific to your project, such as features, requirements, specifications, test cases, …

Developed for safety

Allows you to define the exact way of using and configuring need objects, to create documentation valid with ISO 26262, DO-178B/C or any other safety standard.

Highly customizable

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.

Integration with external sources

Import and export mechanisms facilitate external synchronization with other tools, such as JIRA, GitHub, or spreadsheets, allowing for embedding tickets, requirements and other information into your documentation.

Automated data handling

Dynamic functions allow you to handle complex data chains between needs, to load and set changeable data automatically during the documentation generation phase.

PlantUML integration

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:

https://useblocks.com

Provides an oversight of the useblocks ecosystem, and its goal to bring Engineering-as-Code to the software development process.

https://useblocks.com
Sphinx-Bazel

Provides a Bazel domain in Sphinx documentation and allows the automated import of Bazel files and their documentation.

https://sphinx-bazel.readthedocs.io/en/latest/
Sphinx-Collections

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.

https://sphinx-collections.readthedocs.io/en/latest/
Sphinx-Test-Reports

Extension to import test results from XML files as need objects.

Created need objects can be filtered and linked to specification objects.

https://sphinx-test-reports.readthedocs.io/en/latest/

Contents