Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ubCode 0.13.0 documentation
Light Logo Dark Logo

Basics

  • Installation
  • Quickstart

User Guides

  • Coming from Sphinx-Needs
  • License configuration
  • Configuring a project with ubproject.toml
  • Troubleshooting
  • Writing a filter

Extension Features

  • Home view
  • Linting
  • RST preview
  • Realtime index
  • Filtering
  • Navigation
  • Commands
  • needs.json view

ubc CLI app

  • Introduction
  • Installation
  • Usage

References

  • References
    • ubproject.toml schema

Contact

  • Request a license
  • Report an issue

Development

  • Roadmap
  • Changelog
Back to top
View this page
Edit this page

Installation¶

  1. Open your project in VS Code, go to the Extensions tab and search for the ubCode extension.

    Extension ubCode
  2. Click on the “Install” button.

  3. Next steps

    • Read details in the section Coming from Sphinx-Needs.

    • Write a ubproject.toml.

See also

  • The Sphinx guide for setting up a Sphinx project.

  • The Sphinx-Needs documentation.

Next
Quickstart
Previous
Home
Copyright © 2025, team useblocks
Made with Sphinx and @pradyunsg's Furo