Skip to content

Commit 0cbe173

Browse files
committed
Address review feedback on documentation
- Remove Python bindings references (WIP, not fully functional) - Fix rawtoaces_core.rst: remove non-existent classes, add actual functions - Elaborate on data path: mention CMAKE_INSTALL_PREFIX, Windows limitation - Add --data-dir command line parameter to environment setup - Fix illuminant docs: blackbody temperatures must be below 4000K - Fix dependencies: remove LibRaw (handled by OIIO), add nlohmann-json - Fix spectral_data.rst: explicitly list Spectrum and SpectralData structs Signed-off-by: pmady <[email protected]>
1 parent 6c5b3b7 commit 0cbe173

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

docs/api/spectral_data.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,20 @@ The spectral data module provides structures for representing:
1717
- Color matching functions (CMFs)
1818
- Training spectral data
1919

20-
Data Structures
21-
---------------
20+
Spectrum
21+
--------
22+
23+
.. doxygenstruct:: rta::core::Spectrum
24+
:members:
25+
:undoc-members:
26+
27+
.. doxygenstruct:: rta::core::Spectrum::Shape
28+
:members:
29+
:undoc-members:
30+
31+
SpectralData
32+
------------
2233

23-
.. doxygenfile:: spectral_data.h
24-
:sections: briefdescription detaileddescription innerclass innernamespace typedef enum func var define
34+
.. doxygenstruct:: rta::core::SpectralData
35+
:members:
36+
:undoc-members:

docs/getting_started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ RAWtoACES requires the following dependencies:
1111

1212
- CMake 3.12 or later
1313
- C++17 compatible compiler
14-
- OpenImageIO
15-
- LibRaw
14+
- OpenImageIO (with RAW support via LibRaw)
1615
- Ceres Solver
1716
- Eigen3
17+
- nlohmann-json
1818

1919
Build steps:
2020

0 commit comments

Comments
 (0)