TutorialsΒΆ
Step-by-step guides to get you started with Sphinx-Needs documentation.
- Setting Up a Sphinx-Needs Project
- Prerequisites
- What is Sphinx?
- Step 1: Create Project Directory
- Step 2: Set Up Python Environment with uv
- Step 3: Install Dependencies
- Step 4: Initialize Sphinx Project
- Step 5: Create the ubproject.toml Configuration
- Step 6: Configure conf.py
- Step 7: Create Your First Documentation
- Step 8: Write Requirements
- Step 9: Add Specifications and Tests
- Step 10: Create Traceability Views
- Step 11: Build the Documentation
- Final Project Structure
- Understanding ubproject.toml
- VS Code Setup with ubCode
- Common Commands Reference
- Next Steps
- Troubleshooting
- Next Steps
- Setting Up PlantUML for Sphinx-Needs
- Why PlantUML?
- Prerequisites
- Step 1: Install Java
- Step 2: Install Graphviz (Recommended)
- Step 3: Download PlantUML JAR
- Step 4: Install sphinxcontrib-plantuml
- Step 5: Configure conf.py
- Step 6: Using PlantUML Diagrams
- Step 7: PlantUML Styling
- Step 8: Debugging PlantUML
- Step 9: CI/CD Configuration
- Troubleshooting
- Project Structure
- Next Steps
- Creating Powerful Dashboards
- Prerequisites
- What Are Dashboards?
- Setting Up Sample Data
- Creating Tables with needtable
- Visualizing Status with needpie
- Comparing Metrics with needbar
- Showing Relationships with needflow
- Timeline Views with needgantt
- Building a Complete Dashboard
- Tips and Best Practices
- Limitations and Advanced Solutions
- Next Steps
- Setting Up ubCode and ubConnect Licenses
- Prerequisites
- Overview
- Method 1: Configuration File Setup
- Method 2: Environment Variables
- Setting Environment Variables on Host Systems
- Docker Container Configuration
- DevContainer Configuration
- Setting Variables Directly in Container
- CI/CD Pipeline Configuration
- Offline License Configuration
- License Caching
- Troubleshooting
- Security Best Practices
- Quick Reference