Introduction

Enhance Sphinx-Needs experience in VS Code.

A lightning-fast language server that deeply understands Sphinx-Needs to provide a joyful editing experience.

Get Started

About useblocks

This project offers tools to enhance the authoring experience with Sphinx needs documentation projects. A new language server delivers code intelligence and provides real-time previews.

Key features:

• Real-time indexing of RST files

• Real-time previews of RST files

• Linting

• Smart need filtering

• Editor navigation

Upcoming features can be found on our Roadmap.

Caution

ubCode is in an early development stage.

We welcome your feedback!

If you don’t have a Github account, contact us via support.

Contents

Basics

• Installation
• Quickstart
  • Create a basic project
  • Run script commands

User Guides

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

Extension Features

• Home view
  • Activate a license key
  • Tutorials
• Linting
• RST preview
• Realtime index
  • Indexing
  • Imported needs
  • External needs
  • Large projects
  • Indexing errors
  • Index View
  • Select ID in index view
• Filtering
• Navigation
• Commands
• needs.json view

References

• References

Contact

• Request a license
  • License handling
• Report an issue

Development

• Roadmap
• Changelog