Skip to content
Snippets Groups Projects

Draft: Add sphinx documentation

Closed Tammo Jan Dijkema requested to merge add-sphinx into main
1 file
+ 13
7
Compare changes
  • Side-by-side
  • Inline
+ 13
7
@@ -197,11 +197,15 @@ void init_settings(py::module& m) {
.def_readwrite("image", &radler::Settings::LocalRms::image,
DOC(radler_Settings_LocalRms_image));
py::class_<radler::Settings::SpectralFitting>(settings, "SpectralFitting", DOC(radler_Settings_SpectralFitting))
.def_readwrite("mode", &radler::Settings::SpectralFitting::mode, DOC(radler_Settings_SpectralFitting_mode))
.def_readwrite("terms", &radler::Settings::SpectralFitting::terms, DOC(radler_Settings_SpectralFitting_terms))
py::class_<radler::Settings::SpectralFitting>(
settings, "SpectralFitting", DOC(radler_Settings_SpectralFitting))
.def_readwrite("mode", &radler::Settings::SpectralFitting::mode,
DOC(radler_Settings_SpectralFitting_mode))
.def_readwrite("terms", &radler::Settings::SpectralFitting::terms,
DOC(radler_Settings_SpectralFitting_terms))
.def_readwrite("forced_filename",
&radler::Settings::SpectralFitting::forced_filename, DOC(radler_Settings_SpectralFitting_forced_filename));
&radler::Settings::SpectralFitting::forced_filename,
DOC(radler_Settings_SpectralFitting_forced_filename));
py::enum_<aocommon::Polarization::PolarizationEnum>(
m, "Polarization",
@@ -219,10 +223,12 @@ void init_settings(py::module& m) {
.value("yx", aocommon::PolarizationEnum::YX)
.value("yy", aocommon::PolarizationEnum::YY)
.value("full_stokes", aocommon::PolarizationEnum::FullStokes,
DOC(aocommon_Polarization_PolarizationEnum_FullStokes))
.value("instrumental", aocommon::PolarizationEnum::Instrumental, DOC(aocommon_Polarization_PolarizationEnum_Instrumental))
DOC(aocommon_Polarization_PolarizationEnum_FullStokes))
.value("instrumental", aocommon::PolarizationEnum::Instrumental,
DOC(aocommon_Polarization_PolarizationEnum_Instrumental))
.value("diagonal_instrumental",
aocommon::PolarizationEnum::DiagonalInstrumental, DOC(aocommon_Polarization_PolarizationEnum_DiagonalInstrumental))
aocommon::PolarizationEnum::DiagonalInstrumental,
DOC(aocommon_Polarization_PolarizationEnum_DiagonalInstrumental))
// PolarizationEnum is an unscoped enum, hence export_values(). See
// https://pybind11.readthedocs.io/en/stable/classes.html?highlight=export_values#enumerations-and-internal-types.
.export_values();
Loading