View rendered documentation at https://sphinx-needs-demo.readthedocs.io
This a demo documentation project to show the usage of Sphinx-Needs in the context of an Automitve SW development documentation.
A preconfigured VS Code IDE instance is available on Gitpod, which allows you to play around with the docs, build it and view the outcome in the browser.
Just start it by following this link: https://gitpod.io/#https://github.com/useblocks/sphinx-needs-demo
It does not cost anything, but an account creation may be needed.
Just start it by clicking this badge:
Want to use ubcode inside the Codespace? Then you need to configure the required environment variables as Codespace secrets in your github user settings:
- Navigate to your GitHub user settings
- Go to Settings → Code, planning, and automation → Codespaces
- Add the following Codespace user secrets and assign them to the useblocks sphinx-needs-demo repository:
UBCODE_LICENSE_KEY: Your ubCode license keyUBCODE_LICENSE_USER: Your registered email address
This project includes a preconfigured development container (devcontainer) setup, making it easy to get started with a consistent development environment.
To learn how to use the devcontainer, see the detailed instructions in .devcontainer/README.md.