Skip to content

Add Read the Docs configuration and Sphinx documentation stubs#34

Merged
AwaKhouna merged 5 commits intomainfrom
oceanpy-docs
Apr 7, 2026
Merged

Add Read the Docs configuration and Sphinx documentation stubs#34
AwaKhouna merged 5 commits intomainfrom
oceanpy-docs

Conversation

@AwaKhouna
Copy link
Copy Markdown
Collaborator

Set up Read the Docs integration with configuration for Python 3.12 and Ubuntu 24.04. Add Sphinx documentation infrastructure including Makefile for building HTML docs. Implement stub modules for optional dependencies (Gurobi, OR-Tools, PySAT) to enable documentation generation without requiring these packages to be installed.

Set up Read the Docs integration with configuration for Python 3.12 and Ubuntu 24.04. Add Sphinx documentation infrastructure including Makefile for building HTML docs. Implement stub modules for optional dependencies (Gurobi, OR-Tools, PySAT) to enable documentation generation without requiring these packages to be installed.
@AwaKhouna AwaKhouna requested review from eminyous and ferryjul April 3, 2026 22:20
Implement post-processed distance calculation for MIP, CP, and MaxSAT explainers that computes the Lp distance between the query and decoded counterfactual. Update CP backend to support integer norms >= 1 (previously L1 only). Add comprehensive tests validating distance calculations against manual implementations. Improve documentation coverage. Update user-facing docs to reflect CP norm support and distance retrieval workflow.
@AwaKhouna AwaKhouna merged commit d3149f6 into main Apr 7, 2026
8 checks passed
@AwaKhouna AwaKhouna deleted the oceanpy-docs branch April 7, 2026 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants