Supercharge your Sphinx project

For teams with a Sphinx or Sphinx-Needs project who want live feedback and CI checks, and keep their Sphinx build.

With Sphinx-Needs

1. Coming from Sphinx-Needs moves your configuration to ubproject.toml and keeps your Sphinx build working.

2. Installation gets you the VS Code extension.

3. Realtime index and Linting show the live index and its diagnostics as you type.

4. RST preview, Navigation and Needs graph view preview, navigate and draw your needs.

5. What works inside imported need content and Supported toolchain say which parts of your project ubCode understands; Unsupported syntax and Differences from a Sphinx build list the markup it does not render, or renders differently.

6. Linting on the command line and Using ubc in CI/CD add ubc check to CI as a quality gate.

7. Writing a filter queries your needs from the editor or the command line.

With plain Sphinx

1. Installation gets you the VS Code extension.

2. Configuring a project with ubproject.toml describes your project to ubCode.

3. RST preview previews your documents as you write.

4. Linting catches markup errors as you type.

5. Formatting formats your files.

6. Intersphinx resolves references into other projects’ documentation.

7. Link checking checks your external links.

Next steps

• Upgrade path: build the site and the PDF without Python with Publish documentation, then manage requirements with ubCode alone with Manage requirements and traceability.

• For your team: ubCode for teams covers licensing, offline use and support.

Use it at work. ubCode is free for open-source projects, and a private project needs a commercial license. Request a free enterprise trial to evaluate it on your own private project.