sphinx-ultra 0.3.0

High-performance Rust-based Sphinx documentation builder for large codebases
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

Validation Examples
==================

This document shows Sphinx Ultra's new constraint validation system with simple examples.

Working Requirements (These Pass Validation)
--------------------------------------------

.. req:: REQ-001
   :title: User Login System
   :status: complete
   :priority: high
   
   Users can log in with username and password.

.. req:: REQ-002  
   :title: Password Reset
   :status: verified
   :priority: medium
   
   Users can reset their password via email.

Failing Requirements (These Will Fail Validation)
-------------------------------------------------

.. req:: REQ-003
   :title: Security Audit
   :status: open
   :priority: critical
   
   ❌ This will fail - Critical priority items must be complete!

.. req:: REQ-004
   :title: Data Backup
   :status: pending
   :priority: high
   
   ❌ This will fail - High priority items must be complete!

.. req:: REQ-005
   :title: Invalid Priority Example
   :status: complete
   :priority: super-high
   
   ❌ This will fail - Invalid priority value!

Running Validation
------------------

To see these validation failures in action:

.. code-block:: bash

   cargo run --example constraint_validation

You'll see which requirements pass and which fail the validation rules!