Sphinx-Needs Demo

This is a demo documentation for showing the features of Sphinx-Needs.

_images/sphinx-needs-logo-bg.png

A simple Automotive SW project is used as playground, with elements for:

  • Requirements

  • Specifications

  • Implementations

  • Test Cases

  • and Test Results

Open this playground in an Online Editor!

Architecture diagrams get described by PlantUML.

There are also Dashboard pages to show specific information for different process roles.

The complete source code can be found here: https://github.com/useblocks/sphinx-needs-demo

Features and technical details are described inside dropdowns like this one:

Demo feature hint: Just an example

Really, this is just an example. Nothing more.

Demo Content

Most of the need content was created using AI. Also most of the images were generated this way.

However, all the meta-data, configuration, and analysis were set by hand, so that the setup shows examples of a real-world use cases and solutions.

Demo playground

This Demo includes also a specialized docs-as-code setup for a Gitpod online IDE.

You can open it by simply clicking this link: Gitpod Sphinx-Needs-Demo IDE.

A login with a Gitpod or GitHub account is needed. After this, you can use the online IDE for 50 hours per month for free.

The Gitpod IDE provides the following features:

  • Automatical clone of the requested repository

  • Starting a selected docker container and using it as the build environment

  • Install all needed Python dependencies (Sphinx + extensions)

  • Load preconfigured VS Code extensions (Restructured text support, Esbonio, Previewer)

  • Launch configuration to build the Sphinx demo project

Page Content

Explanation

Demonstration