Observable report

.github/workflows/python-package.yml

@@ -40,6 +40,10 @@ jobs:
     - name: Show package version
       run: grep -r "version" pyproject.toml || grep -r "__version__" rtichoke/ || python -c "import rtichoke; print(rtichoke.__version__)"
 
+    - name: Render and Publish
+      working-directory: docs
+      run: uv run quarto publish gh-pages --no-browser --token "${{ secrets.GITHUB_TOKEN }}"
+
     - name: Publish package
       if: github.ref == 'refs/heads/main' && matrix.python-version == '3.10'
       run: uv publish

.gitignore

@@ -140,4 +140,18 @@ dmypy.json
 
 # MacOS
 .DS_Store
+*.html
 docs/walkthrough_aj_estimate.html
+docs/_site/walkthrough_aj_estimate.html
+docs/_site/walkthrough_aj_estimate.html
+src/rtichoke/summary_report/summary_report_template.html
+docs/_site/walkthrough_aj_estimate.html
+docs/_site/walkthrough_aj_estimate.html
+docs/combined_adjusted_data.pkl
+docs/_site/walkthrough_aj_estimate.html
+probs_dict.pkl
+docs/_site/walkthrough_aj_estimate.html
+reals_dict.pkl
+times_dict.pkl
+docs/_site/example.html
+docs/_site/walkthrough_aj_estimate.html

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.11.13
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+    # Run the formatter.
+    - id: ruff-format
+- repo: https://github.com/astral-sh/uv-pre-commit
+  # uv version.
+  rev: 0.7.12
+  hooks:
+    # Update the uv lockfile
+    - id: uv-lock

docs/_brand.yml

@@ -0,0 +1,41 @@
+color:
+  palette:
+    white: "#fff7f5"
+    black: "#000000"
+    navbar-bg: white  # alias
+    navbar-fg: "#c54b29"
+    navbar-hl: "#c54b29"
+    primary: "#FEF0EC"
+    link: "#ce3d15"
+  background: white
+  foreground: black
+  primary: primary
+  light: white
+  dark: black
+  danger: navbar-fg
+  link: link
+
+typography:
+  fonts:
+    - family: Fraunces
+      source: google
+      weight: [400, 700]
+      style: [normal, italic]
+    - family: Commissioner
+      source: google
+      weight: [400, 600]
+      style: [normal, italic]
+  base:
+    family: Commissioner
+    size: 16px
+    weight: 400
+    line-height: 1.5
+  headings:
+    family: Fraunces
+    weight: 700
+    style: normal
+    line-height: 1.2
+  link:
+    color: link
+    weight: 600
+    decoration: underline

docs/_quarto.yml

@@ -5,27 +5,38 @@ metadata-files:
   - _sidebar.yml
 
 website:
-  title: "My Documentation Site"
+  title: "rtichoke"
   navbar:
     left:
-      - href: index.qmd
-        text: Home
-      - href: about.qmd
-        text: About
+      - href: reference.qmd
+        text: Reference
       - href: walkthrough_aj_estimate.qmd
         text: Example
+      - href: before_we_validate.qmd
+        text: Before we Validate
 
 quartodoc:
   # the name used to import the package you want to create reference docs for
   package: rtichoke
   sidebar: "_sidebar.yml"
   sections:
     - title: Calibration
-      desc: Functions to inspect docstrings.
+      desc: Functions for Calibration.
       contents:
         - create_calibration_curve
     - title: Discrimination
-      desc: Functions to inspect docstrings.
+      desc: Functions for Discrimination.
       contents:
+        - create_roc_curve
+        - create_precision_recall_curve
         - create_gains_curve
-        - plot_precision_recall_curve
+        - create_lift_curve
+        - plot_roc_curve
+        - plot_precision_recall_curve
+        - plot_gains_curve
+        - plot_lift_curve
+    - title: Utility
+      desc: Functions for Utility.
+      contents:
+        - create_decision_curve
+        - plot_decision_curve

docs/_sidebar.yml

@@ -6,8 +6,18 @@ website:
       - reference/create_calibration_curve.qmd
       section: Calibration
     - contents:
+      - reference/create_roc_curve.qmd
+      - reference/create_precision_recall_curve.qmd
       - reference/create_gains_curve.qmd
+      - reference/create_lift_curve.qmd
+      - reference/plot_roc_curve.qmd
       - reference/plot_precision_recall_curve.qmd
+      - reference/plot_gains_curve.qmd
+      - reference/plot_lift_curve.qmd
       section: Discrimination
+    - contents:
+      - reference/create_decision_curve.qmd
+      - reference/plot_decision_curve.qmd
+      section: Utility
     id: reference
   - id: dummy-sidebar