Merge pull request #77 from Point72/tkp/b

Add breathe integration

Author: timkpaine

.github/workflows/build.yaml

@@ -39,6 +39,15 @@ jobs:
       with:
         version: ${{ matrix.python-version }}
 
+    - name: Install Rust
+      uses: dtolnay/rust-toolchain@stable
+
+    - 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
 

.github/workflows/docs.yaml

@@ -10,6 +10,14 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install doxygen
+        run: sudo apt-get install -y doxygen
+
       - uses: actions-ext/yardang@main
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

docs/src/api.md

@@ -0,0 +1,105 @@
+# API Reference
+
+## Python API
+
+### yardang.build
+
+```{eval-rst}
+.. automodule:: yardang.build
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+### yardang.cli
+
+```{eval-rst}
+.. automodule:: yardang.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+### yardang.utils
+
+```{eval-rst}
+.. automodule:: yardang.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## C++ Example
+
+This is an example of documenting C++ code using breathe integration.
+
+### Document Everything
+
+Use `doxygenindex` to document all symbols from Doxygen XML:
+
+```doxygenindex
+```
+
+```{toctree}
+:hidden:
+:maxdepth: 2
+
+/examples/cpp/docs/api
+```
+
+### Document Individual Classes
+
+Or document specific classes with `doxygenclass`:
+
+```doxygenclass calc::Calculator
+:members:
+```
+
+```doxygenclass calc::ScientificCalculator
+: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:
+
+```{eval-rst}
+.. rust:crate:: calculator
+
+```
+
+```{toctree}
+:hidden:
+:maxdepth: 2
+
+/api/crates/calculator/index
+```
+
+### Document Individual Items
+
+Or document specific structs, enums, and functions:
+
+```{eval-rst}
+.. rust:struct:: calculator::Calculator
+
+```
+
+```{eval-rst}
+.. rust:struct:: calculator::ScientificCalculator
+
+```
+
+```{eval-rst}
+.. rust:enum:: calculator::Operation
+
+```
+
+```{eval-rst}
+.. rust:enum:: calculator::CalculatorError
+
+```
+