wip rust ext

Author: timkpaine

.github/workflows/build.yaml

@@ -42,6 +42,9 @@ jobs:
     - name: Install doxygen
       run: sudo apt-get install -y doxygen
 
+    - name: Clean up problematic directories
+      run: rm -rf docs/jupyter_execute
+
     - name: Install dependencies
       run: make develop
 

docs/src/api.md

@@ -52,3 +52,30 @@ Or document specific classes with `doxygenclass`:
 :members:
 ```
 
+## Rust Example
+
+This is an example of documenting Rust code using sphinx-rust integration.
+
+### Document a Crate
+
+Use `rust:crate` to document an entire Rust crate:
+
+```rust:crate calculator
+```
+
+### Document Individual Items
+
+Or document specific structs, enums, and functions:
+
+```rust:struct calculator::Calculator
+```
+
+```rust:struct calculator::ScientificCalculator
+```
+
+```rust:enum calculator::Operation
+```
+
+```rust:enum calculator::CalculatorError
+```
+

examples/rust/.gitignore

@@ -0,0 +1,2 @@
+/target/
+Cargo.lock

examples/rust/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "calculator"
+version = "0.1.0"
+edition = "2021"
+description = "A simple calculator library demonstrating Rust documentation"
+license = "Apache-2.0"
+
+[lib]
+name = "calculator"
+path = "src/lib.rs"

examples/rust/README.md

@@ -0,0 +1,47 @@
+# Calculator Library (Rust)
+
+A simple calculator library demonstrating Rust documentation with sphinx-rust.
+
+## Features
+
+- Basic arithmetic operations (add, subtract, multiply, divide)
+- Scientific calculator with trigonometric and logarithmic functions
+- Operation history tracking
+- Full Rust documentation with examples
+
+## Usage
+
+```rust
+use calculator::{Calculator, Operation};
+
+fn main() {
+    let mut calc = Calculator::new();
+    
+    // Basic operations
+    let sum = calc.add(5.0, 3.0);
+    println!("5 + 3 = {}", sum);
+    
+    let product = calc.multiply(4.0, 7.0);
+    println!("4 * 7 = {}", product);
+    
+    // View history
+    for result in calc.history() {
+        println!("{}", result);
+    }
+}
+```
+
+## Scientific Calculator
+
+```rust
+use calculator::ScientificCalculator;
+
+fn main() {
+    let mut sci = ScientificCalculator::new();
+    sci.set_use_degrees(true);
+    
+    println!("sin(90°) = {}", sci.sin(90.0));
+    println!("sqrt(16) = {}", sci.sqrt(16.0));
+    println!("2^10 = {}", sci.pow(2.0, 10.0));
+}
+```