diff --git a/docs/api/bacon.rst b/docs/api/bacon.rst index 9f7e388d..10a0a5f8 100644 --- a/docs/api/bacon.rst +++ b/docs/api/bacon.rst @@ -37,6 +37,7 @@ Main estimator class for the Goodman-Bacon decomposition. :undoc-members: :show-inheritance: :inherited-members: + :no-index: .. rubric:: Methods @@ -55,6 +56,7 @@ Results container for the Bacon decomposition. :members: :undoc-members: :show-inheritance: + :no-index: .. rubric:: Methods @@ -75,6 +77,7 @@ Container for an individual 2x2 DiD comparison within the decomposition. :members: :undoc-members: :show-inheritance: + :no-index: Convenience Function -------------------- diff --git a/docs/api/business_report.rst b/docs/api/business_report.rst index 093bc0a9..953b6e2d 100644 --- a/docs/api/business_report.rst +++ b/docs/api/business_report.rst @@ -98,10 +98,12 @@ API --- .. autoclass:: diff_diff.BusinessReport + :no-index: :members: :show-inheritance: .. autoclass:: diff_diff.BusinessContext + :no-index: :members: :show-inheritance: diff --git a/docs/api/chaisemartin_dhaultfoeuille.rst b/docs/api/chaisemartin_dhaultfoeuille.rst index 04084618..3a240da7 100644 --- a/docs/api/chaisemartin_dhaultfoeuille.rst +++ b/docs/api/chaisemartin_dhaultfoeuille.rst @@ -109,6 +109,7 @@ Main estimator class for de Chaisemartin-D'Haultfœuille (dCDH) DiD estimation. The alias :class:`~diff_diff.DCDH` is also available. .. autoclass:: diff_diff.ChaisemartinDHaultfoeuille + :no-index: :members: :undoc-members: :show-inheritance: @@ -128,6 +129,7 @@ ChaisemartinDHaultfoeuilleResults Results container for dCDH estimation. .. autoclass:: diff_diff.ChaisemartinDHaultfoeuilleResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -146,6 +148,7 @@ DCDHBootstrapResults Multiplier-bootstrap inference results, populated when ``n_bootstrap > 0``. .. autoclass:: diff_diff.DCDHBootstrapResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -168,6 +171,7 @@ treatment effects that could flip the sign of the plain TWFE coefficient. .. autofunction:: diff_diff.twowayfeweights .. autoclass:: diff_diff.chaisemartin_dhaultfoeuille.TWFEWeightsResult + :no-index: :members: Example Usage diff --git a/docs/api/continuous_did.rst b/docs/api/continuous_did.rst index 01b2be7f..fc3b758b 100644 --- a/docs/api/continuous_did.rst +++ b/docs/api/continuous_did.rst @@ -46,6 +46,7 @@ ContinuousDiD Main estimator class for Continuous Difference-in-Differences. .. autoclass:: diff_diff.ContinuousDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -65,6 +66,7 @@ ContinuousDiDResults Results container for Continuous DiD estimation. .. autoclass:: diff_diff.continuous_did_results.ContinuousDiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -83,6 +85,7 @@ DoseResponseCurve Dose-response curve container for ATT(d) or ACRT(d). .. autoclass:: diff_diff.continuous_did_results.DoseResponseCurve + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/diagnostic_report.rst b/docs/api/diagnostic_report.rst index 3745beb2..e0cc3375 100644 --- a/docs/api/diagnostic_report.rst +++ b/docs/api/diagnostic_report.rst @@ -73,10 +73,12 @@ API --- .. autoclass:: diff_diff.DiagnosticReport + :no-index: :members: :show-inheritance: .. autoclass:: diff_diff.DiagnosticReportResults + :no-index: :members: :show-inheritance: diff --git a/docs/api/diagnostics.rst b/docs/api/diagnostics.rst index 218e035d..ec70a1f5 100644 --- a/docs/api/diagnostics.rst +++ b/docs/api/diagnostics.rst @@ -130,6 +130,7 @@ PlaceboTestResults Container for placebo test results. .. autoclass:: diff_diff.PlaceboTestResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/efficient_did.rst b/docs/api/efficient_did.rst index bba00a97..ba58e5c3 100644 --- a/docs/api/efficient_did.rst +++ b/docs/api/efficient_did.rst @@ -49,6 +49,7 @@ EfficientDiD Main estimator class for Efficient Difference-in-Differences. .. autoclass:: diff_diff.EfficientDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -68,6 +69,7 @@ EfficientDiDResults Results container for Efficient DiD estimation. .. autoclass:: diff_diff.efficient_did_results.EfficientDiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -86,6 +88,7 @@ EDiDBootstrapResults Bootstrap inference results for Efficient DiD. .. autoclass:: diff_diff.efficient_did_bootstrap.EDiDBootstrapResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/estimators.rst b/docs/api/estimators.rst index 54bf2c3f..d9e63879 100644 --- a/docs/api/estimators.rst +++ b/docs/api/estimators.rst @@ -31,6 +31,7 @@ DifferenceInDifferences (alias: ``DiD``) Basic 2x2 DiD estimator. .. autoclass:: diff_diff.DifferenceInDifferences + :no-index: :members: :undoc-members: :show-inheritance: @@ -50,6 +51,7 @@ MultiPeriodDiD (alias: ``EventStudy``) Event study estimator with period-specific treatment effects. .. autoclass:: diff_diff.MultiPeriodDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -63,6 +65,7 @@ Panel DiD with unit and time fixed effects. .. module:: diff_diff.twfe .. autoclass:: diff_diff.TwoWayFixedEffects + :no-index: :members: :undoc-members: :show-inheritance: @@ -76,6 +79,7 @@ Synthetic control combined with DiD (Arkhangelsky et al. 2021). .. module:: diff_diff.synthetic_did .. autoclass:: diff_diff.SyntheticDiD + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/had.rst b/docs/api/had.rst index 8eff00b2..e6914d42 100644 --- a/docs/api/had.rst +++ b/docs/api/had.rst @@ -120,6 +120,7 @@ HeterogeneousAdoptionDiD ------------------------ .. autoclass:: diff_diff.HeterogeneousAdoptionDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -130,6 +131,7 @@ HeterogeneousAdoptionDiDResults Single-period results container for ``HeterogeneousAdoptionDiD`` estimation. .. autoclass:: diff_diff.HeterogeneousAdoptionDiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -140,6 +142,7 @@ HeterogeneousAdoptionDiDEventStudyResults Multi-period event-study results container for the Appendix B.2 extension. .. autoclass:: diff_diff.HeterogeneousAdoptionDiDEventStudyResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -162,6 +165,7 @@ unified :class:`~diff_diff.HADPretestReport`. .. autofunction:: diff_diff.did_had_pretest_workflow .. autoclass:: diff_diff.HADPretestReport + :no-index: :members: :undoc-members: :show-inheritance: @@ -176,16 +180,19 @@ Single-period tests (``aggregate="overall"``) .. autofunction:: diff_diff.yatchew_hr_test .. autoclass:: diff_diff.QUGTestResults + :no-index: :members: :undoc-members: :show-inheritance: .. autoclass:: diff_diff.StuteTestResults + :no-index: :members: :undoc-members: :show-inheritance: .. autoclass:: diff_diff.YatchewTestResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -200,6 +207,7 @@ Joint multi-period tests (``aggregate="event_study"``) .. autofunction:: diff_diff.joint_homogeneity_test .. autoclass:: diff_diff.StuteJointResult + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/honest_did.rst b/docs/api/honest_did.rst index afddfa39..6fd000cd 100644 --- a/docs/api/honest_did.rst +++ b/docs/api/honest_did.rst @@ -27,6 +27,7 @@ HonestDiD Main class for computing honest bounds and confidence intervals. .. autoclass:: diff_diff.HonestDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -65,6 +66,7 @@ HonestDiDResults Results from HonestDiD estimation. .. autoclass:: diff_diff.HonestDiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -75,6 +77,7 @@ SensitivityResults Results from sensitivity analysis over a grid of M values. .. autoclass:: diff_diff.SensitivityResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -88,6 +91,7 @@ DeltaSD Smoothness restriction class. .. autoclass:: diff_diff.DeltaSD + :no-index: :members: :undoc-members: :show-inheritance: @@ -98,6 +102,7 @@ DeltaRM Relative magnitudes restriction class. .. autoclass:: diff_diff.DeltaRM + :no-index: :members: :undoc-members: :show-inheritance: @@ -108,6 +113,7 @@ DeltaSDRM Combined smoothness and relative magnitudes restriction. .. autoclass:: diff_diff.DeltaSDRM + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/imputation.rst b/docs/api/imputation.rst index fc91ca39..751a97ba 100644 --- a/docs/api/imputation.rst +++ b/docs/api/imputation.rst @@ -36,6 +36,7 @@ ImputationDiD Main estimator class for imputation DiD estimation. .. autoclass:: diff_diff.ImputationDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -55,6 +56,7 @@ ImputationDiDResults Results container for imputation DiD estimation. .. autoclass:: diff_diff.ImputationDiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -74,6 +76,7 @@ ImputationBootstrapResults Bootstrap inference results. .. autoclass:: diff_diff.ImputationBootstrapResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/local_linear.rst b/docs/api/local_linear.rst index 2b55a7dc..6e90a888 100644 --- a/docs/api/local_linear.rst +++ b/docs/api/local_linear.rst @@ -61,6 +61,7 @@ Kernel-weighted OLS estimator of the conditional mean .. autofunction:: diff_diff.local_linear_fit .. autoclass:: diff_diff.LocalLinearFit + :no-index: :members: :undoc-members: :show-inheritance: @@ -76,6 +77,7 @@ selector against the R ``nprobust`` reference. .. autofunction:: diff_diff.mse_optimal_bandwidth .. autoclass:: diff_diff.BandwidthResult + :no-index: :members: :undoc-members: :show-inheritance: @@ -91,6 +93,7 @@ and 95% confidence interval. .. autofunction:: diff_diff.bias_corrected_local_linear .. autoclass:: diff_diff.BiasCorrectedFit + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/power.rst b/docs/api/power.rst index 52d57c39..dbbb9b57 100644 --- a/docs/api/power.rst +++ b/docs/api/power.rst @@ -22,6 +22,7 @@ PowerAnalysis Main class for analytical power calculations. .. autoclass:: diff_diff.PowerAnalysis + :no-index: :members: :undoc-members: :show-inheritance: @@ -63,6 +64,7 @@ PowerResults Results from power analysis. .. autoclass:: diff_diff.PowerResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -73,6 +75,7 @@ SimulationPowerResults Results from simulation-based power analysis. .. autoclass:: diff_diff.SimulationPowerResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -83,6 +86,7 @@ SimulationMDEResults Results from simulation-based MDE search. .. autoclass:: diff_diff.SimulationMDEResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -93,6 +97,7 @@ SimulationSampleSizeResults Results from simulation-based sample size search. .. autoclass:: diff_diff.SimulationSampleSizeResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/pretrends.rst b/docs/api/pretrends.rst index 0d81dc66..c149e73c 100644 --- a/docs/api/pretrends.rst +++ b/docs/api/pretrends.rst @@ -28,6 +28,7 @@ PreTrendsPower Main class for pre-trends power analysis. .. autoclass:: diff_diff.PreTrendsPower + :no-index: :members: :undoc-members: :show-inheritance: @@ -66,6 +67,7 @@ PreTrendsPowerResults Results from pre-trends power analysis. .. autoclass:: diff_diff.PreTrendsPowerResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -76,6 +78,7 @@ PreTrendsPowerCurve Power curve across violation magnitudes. .. autoclass:: diff_diff.PreTrendsPowerCurve + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/profile.rst b/docs/api/profile.rst index 201038ca..46b54f5b 100644 --- a/docs/api/profile.rst +++ b/docs/api/profile.rst @@ -31,6 +31,7 @@ PanelProfile ------------ .. autoclass:: diff_diff.PanelProfile + :no-index: :members: :undoc-members: :show-inheritance: @@ -39,6 +40,7 @@ OutcomeShape ------------ .. autoclass:: diff_diff.OutcomeShape + :no-index: :members: :undoc-members: :show-inheritance: @@ -47,6 +49,7 @@ TreatmentDoseShape ------------------ .. autoclass:: diff_diff.TreatmentDoseShape + :no-index: :members: :undoc-members: :show-inheritance: @@ -55,6 +58,7 @@ Alert ----- .. autoclass:: diff_diff.Alert + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/results.rst b/docs/api/results.rst index bd26d7ac..44d5909c 100644 --- a/docs/api/results.rst +++ b/docs/api/results.rst @@ -11,6 +11,7 @@ DiDResults Results from basic DifferenceInDifferences estimation. .. autoclass:: diff_diff.DiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -42,6 +43,7 @@ MultiPeriodDiDResults Results from MultiPeriodDiD event study estimation. .. autoclass:: diff_diff.MultiPeriodDiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -65,6 +67,7 @@ PeriodEffect Container for a single period's treatment effect in event studies. .. autoclass:: diff_diff.PeriodEffect + :no-index: :members: :undoc-members: :show-inheritance: @@ -75,6 +78,7 @@ SyntheticDiDResults Results from SyntheticDiD estimation. .. autoclass:: diff_diff.SyntheticDiDResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/stacked_did.rst b/docs/api/stacked_did.rst index 4ece0d84..9ae5c617 100644 --- a/docs/api/stacked_did.rst +++ b/docs/api/stacked_did.rst @@ -31,6 +31,7 @@ StackedDiD Main estimator class for Stacked Difference-in-Differences. .. autoclass:: diff_diff.StackedDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -50,6 +51,7 @@ StackedDiDResults Results container for Stacked DiD estimation. .. autoclass:: diff_diff.stacked_did.StackedDiDResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/staggered.rst b/docs/api/staggered.rst index 3c26c9b7..8bf5fbd0 100644 --- a/docs/api/staggered.rst +++ b/docs/api/staggered.rst @@ -19,6 +19,7 @@ CallawaySantAnna Callaway & Sant'Anna (2021) estimator for heterogeneous treatment timing. .. autoclass:: diff_diff.CallawaySantAnna + :no-index: :members: :undoc-members: :show-inheritance: @@ -38,6 +39,7 @@ CallawaySantAnnaResults Results container for Callaway-Sant'Anna estimation. .. autoclass:: diff_diff.CallawaySantAnnaResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -56,6 +58,7 @@ GroupTimeEffect Container for individual group-time ATT(g,t) effects. .. autoclass:: diff_diff.GroupTimeEffect + :no-index: :members: :undoc-members: :show-inheritance: @@ -82,6 +85,7 @@ aggregate cohort-specific effects into event study estimates. in event studies with heterogeneous treatment effects. *Journal of Econometrics*, 225(2), 175-199. .. autoclass:: diff_diff.SunAbraham + :no-index: :members: :undoc-members: :show-inheritance: @@ -103,6 +107,7 @@ SunAbrahamResults Results container for Sun-Abraham estimation. .. autoclass:: diff_diff.SunAbrahamResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -121,6 +126,7 @@ SABootstrapResults Bootstrap inference results for Sun-Abraham estimation. .. autoclass:: diff_diff.SABootstrapResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -132,6 +138,7 @@ Ortiz-Villavicencio & Sant'Anna (2025) staggered triple-difference (DDD) estimat with group-time ATT identification under heterogeneous treatment timing. .. autoclass:: diff_diff.StaggeredTripleDifference + :no-index: :members: :undoc-members: :show-inheritance: @@ -142,6 +149,7 @@ StaggeredTripleDiffResults Results container for ``StaggeredTripleDifference`` estimation. .. autoclass:: diff_diff.StaggeredTripleDiffResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/triple_diff.rst b/docs/api/triple_diff.rst index c521b88f..cb73a72b 100644 --- a/docs/api/triple_diff.rst +++ b/docs/api/triple_diff.rst @@ -30,6 +30,7 @@ TripleDifference Main estimator class for Triple Difference designs. .. autoclass:: diff_diff.TripleDifference + :no-index: :members: :undoc-members: :show-inheritance: @@ -49,6 +50,7 @@ TripleDifferenceResults Results container for Triple Difference estimation. .. autoclass:: diff_diff.TripleDifferenceResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/trop.rst b/docs/api/trop.rst index 8d1eea47..d37c630c 100644 --- a/docs/api/trop.rst +++ b/docs/api/trop.rst @@ -33,6 +33,7 @@ TROP Main estimator class for Triply Robust Panel estimation. .. autoclass:: diff_diff.TROP + :no-index: :members: :undoc-members: :show-inheritance: @@ -52,6 +53,7 @@ TROPResults Results container for TROP estimation. .. autoclass:: diff_diff.trop.TROPResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/two_stage.rst b/docs/api/two_stage.rst index 90dc8de8..ea432b8d 100644 --- a/docs/api/two_stage.rst +++ b/docs/api/two_stage.rst @@ -39,6 +39,7 @@ TwoStageDiD Main estimator class for two-stage DiD estimation. .. autoclass:: diff_diff.TwoStageDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -58,6 +59,7 @@ TwoStageDiDResults Results container for two-stage DiD estimation. .. autoclass:: diff_diff.TwoStageDiDResults + :no-index: :members: :undoc-members: :show-inheritance: @@ -76,6 +78,7 @@ TwoStageBootstrapResults Bootstrap inference results. .. autoclass:: diff_diff.TwoStageBootstrapResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/utils.rst b/docs/api/utils.rst index bcf01713..4cd52faf 100644 --- a/docs/api/utils.rst +++ b/docs/api/utils.rst @@ -112,6 +112,7 @@ WildBootstrapResults Container for wild bootstrap results. .. autoclass:: diff_diff.WildBootstrapResults + :no-index: :members: :undoc-members: :show-inheritance: diff --git a/docs/api/wooldridge_etwfe.rst b/docs/api/wooldridge_etwfe.rst index 21e4bbed..da35d884 100644 --- a/docs/api/wooldridge_etwfe.rst +++ b/docs/api/wooldridge_etwfe.rst @@ -37,6 +37,7 @@ WooldridgeDiD Main estimator class for Wooldridge ETWFE. .. autoclass:: diff_diff.WooldridgeDiD + :no-index: :members: :undoc-members: :show-inheritance: @@ -55,6 +56,7 @@ WooldridgeDiDResults Results container returned by ``WooldridgeDiD.fit()``. .. autoclass:: diff_diff.wooldridge_results.WooldridgeDiDResults + :no-index: :members: :undoc-members: :show-inheritance: