provide docs II

Author: mplatzer

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 ---
-exclude: '^(src/mostlyai/qa/assets)/'
+exclude: '^(src/mostlyai/qa/assets|examples)/'
 repos:
 - repo: local
   hooks:

Makefile

@@ -29,7 +29,7 @@ examples: ## run all examples
 # Targets for Release Workflow/Automation
 .PHONY: release-pypi bump-version update-vars-version build confirm-upload upload clean-dist docs
 
-release-pypi: clean-dist build upload ## release pypi: build, check and upload to pypi
+release-pypi: clean-dist build upload docs ## release pypi: build, check and upload to pypi
 
 # Default files to update
 PYPROJECT_TOML = pyproject.toml

README.md

@@ -83,8 +83,8 @@ report_path, metrics = qa.report(
 
 ## Sample Reports
 
-* **[Baseball Players](https://html-preview.github.io/?url=https://github.com/mostly-ai/mostlyai-qa/blob/main/examples/baseball-players.html)** (Flat Data)
-* **[Baseball Seasons](https://html-preview.github.io/?url=https://github.com/mostly-ai/mostlyai-qa/blob/main/examples/baseball-seasons-with-context.html)** (Sequential Data)
+* [Baseball Players](https://html-preview.github.io/?url=https://github.com/mostly-ai/mostlyai-qa/blob/main/examples/baseball-players.html) (Flat Data)
+* [Baseball Seasons](https://html-preview.github.io/?url=https://github.com/mostly-ai/mostlyai-qa/blob/main/examples/baseball-seasons-with-context.html) (Sequential Data)
 
 ## Citation
 

docs/examples.md

@@ -71,6 +71,7 @@ report_path, metrics = report(
     syn_tgt_data=pd.read_parquet(f"{repo}/{path}/synthetic-target.pqt"),
     trn_tgt_data=pd.read_parquet(f"{repo}/{path}/training-target.pqt"),
     hol_tgt_data=pd.read_parquet(f"{repo}/{path}/holdout-target.pqt"),
+    tgt_context_key="players_id",
     report_subtitle=" for Baseball Seasons",
     report_path="baseball-seasons.html",
 )
@@ -98,7 +99,7 @@ report_path, metrics = report(
     trn_ctx_data=pd.read_parquet(f"{repo}/{path}/training-context.pqt"),
     hol_tgt_data=pd.read_parquet(f"{repo}/{path}/holdout-target.pqt"),
     hol_ctx_data=pd.read_parquet(f"{repo}/{path}/holdout-context.pqt"),
-    tgt_context_key="id",
+    tgt_context_key="players_id",
     ctx_primary_key="id",
     report_subtitle=" for Baseball Seasons",
     report_path="baseball-seasons-with-context.html",

docs/favicon.png

@@ -4,6 +4,7 @@ repo_name: "mostly-ai/mostly-python"
 theme:
   name: material
   logo: logo.png
+  favicon: favicon.png
 
   palette:
   - media: "(prefers-color-scheme)"
@@ -31,8 +32,8 @@ theme:
   features:
     - navigation.instant
     - navigation.instant.prefetch
-    - navigation.tabs
-    - navigation.tabs.sticky
+#    - navigation.tabs
+#    - navigation.tabs.sticky
     - search.suggest
     - search.highlight
     - search.share
@@ -51,9 +52,13 @@ nav:
   - API Reference: api.md
   - Examples: examples.md
 
+extra:
+  version:
+    provider: mike
 
 plugins:
   - search
+  - mike
   - mkdocstrings:
       handlers:
         python: