Merge pull request #11 from artefactory/enh_doc

FIX doc
artefactory · Jan 8, 2024 · f1c693b · f1c693b
2 parents bf8846e + db3c8da
commit f1c693b
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 8 deletions.
diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml
@@ -2,7 +2,11 @@ name: Deploy MkDocs to GitHub Pages
 
 on:
   push:
-    branch: [main]
+    branches: 
+      - main
+  pull_request:
+    branches: 
+      - main
 
 jobs:
   deploy-docs:

diff --git a/docs/references_data.md → ...erences/data/references_choice_dataset.md b/docs/references_data.md → ...erences/data/references_choice_dataset.md
diff --git a/docs/references/data/references_dataset.md b/docs/references/data/references_dataset.md
@@ -0,0 +1,3 @@
+# OpenSource datasets Loaders
+
+:::choice_learn.datasets.base
diff --git a/docs/references/data/references_store.md b/docs/references/data/references_store.md
@@ -0,0 +1,3 @@
+# Features Storage
+
+:::choice_learn.data.store
diff --git a/docs/references_base_model.md → ...eferences/models/references_base_model.md b/docs/references_base_model.md → ...eferences/models/references_base_model.md
@@ -1,3 +1,3 @@
-# ChoiceDataset
+# Base model class
 
 :::choice_learn.models.base_model
diff --git a/docs/references_clogit.md → docs/references/models/references_clogit.md b/docs/references_clogit.md → docs/references/models/references_clogit.md
@@ -1,3 +1,3 @@
-# ChoiceDataset
+# Conditional MNL class
 
 :::choice_learn.models.conditional_mnl
diff --git a/docs/references_rumnet.md → docs/references/models/references_rumnet.md b/docs/references_rumnet.md → docs/references/models/references_rumnet.md
@@ -1,3 +1,3 @@
-# ChoiceDataset
+# RUMnet class
 
 :::choice_learn.models.rumnet
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -54,10 +54,15 @@ nav:
   - How-To Guides:
     - Introduction: how-to-guides.md
     - ChoiceDataset Usage: notebooks/choice_learn_introduction_data.md
+    - Conditional Logit Estimation: notebooks/choice_learn_introduction_clogit.md
+    - Custom Choice Model Creation: notebooks/choice_learn_introduction_data.md
   - References:
-    - references_data.md
+    - Data:
+      - ChoiceDataset: references/data/references_choice_dataset.md
+      - Features Storage: references/data/references_store.md
+      - Available Datasets: references/data/references_dataset.md
     - Choice Models:
-      - Base Model: references_base_model.md
-      - Conditional Logit: references_clogit.md
-      - RUMnet: references_rumnet.md
+      - Base Model: references/models/references_base_model.md
+      - Conditional Logit: references/models/references_clogit.md
+      - RUMnet: references/models/references_rumnet.md
   - explanations.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# OpenSource datasets Loaders

		:::choice_learn.datasets.base