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

Getting started

  • What is ubCode?
  • Key concepts
    • Glossary
  • Installation
  • Quickstart

Configuration & authoring

  • Configuration
    • Needs
    • Card designs with [needs.card_layouts]
    • Field links with [needs.string_links]
    • Schema validation
    • Deprecated needs options
    • Codelinks (source code tracing)
    • Intersphinx
    • Parsing
    • Linting
    • Formatting
    • Server
    • Project, source & scripts
    • HTML site
    • Workflow
    • Quality Analysis
  • Authoring
    • Directives
    • Roles
    • Needs
    • Variants
    • Diagrams
    • Markdown (MyST)
    • Differences from a Sphinx build

Core workflows

  • Needs tutorial
  • Coming from Sphinx-Needs
  • What works inside imported need content
  • Tracing source code with Codelinks
  • Pharaoh Agentic Engineer
    • Quick start
    • Configuring the workflow
    • Reviews and quality analysis
    • The ubc agent command
    • In VS Code

Guides

  • Writing a filter
  • Writing reports
  • Building a static HTML site
  • Variant builds
  • Using ubc in CI/CD

Reference

  • Features
    • Home view
    • Linting
    • RST preview
    • Realtime index
    • Model Context Protocol (MCP) server
    • Chat participant
    • Needs filtering
    • Needs graph view
    • Navigation
    • Site Map
    • Commands
    • Diff & impact analysis
    • needs.json view
  • Supported toolchain

Support

  • Troubleshooting
  • Request a license
  • Report an issue

Development

  • Roadmap
  • Changelog
    • 0.33.x
    • 0.32.x
    • 0.31.x
    • 0.30.x
    • 0.29.x
    • 0.28.x
    • 0.27.x
    • 0.26.x
    • 0.25.x
    • 0.24.x
    • 0.23.x
    • 0.22.x
    • 0.21.x
    • 0.20.x
    • 0.19.x
    • 0.18.x
    • 0.17.x
    • 0.16.x
    • 0.15.x
    • 0.14.x
    • 0.13.x
    • 0.12.x
    • 0.11.x
    • 0.10.x
    • 0.9.x
    • 0.8.x
    • 0.7.x
    • 0.6.x
    • 0.5.x
    • 0.4.x
    • 0.3.x
    • 0.2.x
Back to top
View this page
Edit this page

Configuring a project with ubproject.tomlΒΆ

Note

This page has moved. The configuration reference is now split into focused sub-pages under Configuring a project with ubproject.toml.

  • Needs: Needs

  • Schema validation: Schema validation

  • Deprecated needs options: Deprecated needs options

  • Parsing: Parsing

  • Linting: Linting

  • Formatting: Formatting

  • Server: Server

  • Project, source & scripts: Project, source & scripts

Copyright © 2026, team useblocks
Made with Sphinx and @pradyunsg's Furo