Quickstart

Create a basic project

ubCode can generate a basic Sphinx project for you that already contains a valid ubCode configuration. You may use this as a starting point to bootstrap your Sphinx/Sphinx-Needs project.

Run script commands

ubCode also integrates a script runner that can be used to trigger a Sphinx build from within the editor. The scripts run in the integrated VS Code terminal and can be configured in the ubproject.toml file.

Note

uv is needed to run the script.