wip, might need to separate in two branche, docstring start and quarto config and styles

artiom-matvei · artiom-matvei · commit 200a5decb093 · 2025-01-25T16:39:46.000-05:00
diff --git a/_quarto.yml b/_quarto.yml
@@ -1,4 +1,5 @@
 ####### README #######
+# This references the marginaleffects in .venv first, to reference the local marginaleffects, delete or rename the folder marginaleffects in .venv/lib/
 #
 # To create the qmd files, run the following command in the terminal:
 # > quartodoc build
@@ -15,6 +16,11 @@ project:
 metadata-files:
   - _sidebar.yml
 
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: false
 
 quartodoc:
   # the name used to import the package you want to create reference docs for
@@ -24,14 +30,12 @@ quartodoc:
   sidebar: _sidebar.yml
 
   sections:
-    - title: Some functions
-      desc: Functions to inspect docstrings.
+    - title: Marginaleffects API reference guide
+      desc: Marginaleffects functions.
       contents:
         # the functions being documented in the package.
         # you can refer to anything: class methods, modules, etc..
-        # - avg_predictions
         - predictions
-        - avg_predictions
         - comparisons
         - slopes
         - hypotheses
@@ -41,4 +45,6 @@ quartodoc:
         - plot_slopes
         - model_statsmodels
         - model_sklearn
-        - utils
+        - name: utils
+          members: 
+            - get_dataset
diff --git a/marginaleffects/comparisons.py b/marginaleffects/comparisons.py
@@ -364,6 +364,9 @@ def avg_comparisons(
     transform=None,
     eps=1e-4,
 ):
+    """
+    docstring (TO DO)
+    """
     if callable(newdata):
         newdata = newdata(model)
 
diff --git a/marginaleffects/model_sklearn.py b/marginaleffects/model_sklearn.py
@@ -81,6 +81,9 @@ def get_predict(self, params, newdata: pl.DataFrame):
 def fit_sklearn(
     formula: str, data: pl.DataFrame, engine, kwargs_engine={}, kwargs_fit={}
 ):
+    """
+    fit_sklearn docstring (TO DO)
+    """
     d = listwise_deletion(formula, data=data)
     y, X = model_matrices(formula, d)
     # formulaic returns a matrix when the response is character or categorical
diff --git a/marginaleffects/model_statsmodels.py b/marginaleffects/model_statsmodels.py
@@ -109,6 +109,9 @@ def get_df(self):
 def fit_statsmodels(
     formula: str, data: pl.DataFrame, engine, kwargs_engine={}, kwargs_fit={}
 ):
+    """
+    fit docstring (TO DO)
+    """
     d = fml.listwise_deletion(formula, data=data)
     y, X = fml.model_matrices(formula, d)
     mod = engine(endog=y, exog=X, **kwargs_engine)
diff --git a/marginaleffects/slopes.py b/marginaleffects/slopes.py
@@ -15,6 +15,9 @@ def slopes(
     eps=1e-4,
     eps_vcov=None,
 ):
+    """
+    slopes docstring (TO DO)
+    """
     if callable(newdata):
         newdata = newdata(model)
 
@@ -54,6 +57,9 @@ def avg_slopes(
     eps=1e-4,
     eps_vcov=None,
 ):
+    """
+    avg slopes docstring (TO DO)
+    """
     if callable(newdata):
         newdata = newdata(model)
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,8 +32,7 @@ dev-dependencies = [
   "patsy",
   "pytest >=8.1.1,<9",
   "pytest-xdist >=3.6.1",
-  "ruff>=0.6.4",
-  "quartodoc"
+  "ruff>=0.6.4"
 ]
 
 
diff --git a/styles.css b/styles.css
@@ -0,0 +1,211 @@
+/* css table reproduced from siuba.org repository https://github.com/machow/siuba.org/blob/19c515762b6df13f010803988eda070bcd639f3c/styles.css */
+/* css styles */
+@import url('https://rsms.me/inter/inter.css');
+html { font-family: 'Inter', sans-serif; }
+@supports (font-variation-settings: normal) {
+  html { font-family: 'Inter var', sans-serif; }
+}
+
+:root {
+  --bs-body-font-family: inter;
+  --bs-body-font-size: 16px;
+}
+
+:root {
+  --site-color-primary:  #F9F4D8;/*#ebfddd;*/
+  --site-color-primary: #EE8320;
+  --site-color-primary: #C29A68;
+}
+
+#quarto-header {
+  border: 1px solid #dee2e6;
+  background-color: #FFFFFF;
+}
+
+#quarto-header nav {
+  max-width: 1300px;
+  margin: auto;
+}
+
+#quarto-header .nav-link {
+  padding-left: 5.4px !important;
+  padding-right: 5.4px !important;
+  margin-left: 30px !important;
+  margin-right: 5.4px !important;
+  font-size: 18px;
+}
+
+#quarto-header .nav-link .bi {
+  font-size: 20px;
+}
+
+.sidebar a.nav-link {
+  font-size: 14.4px;
+  font-weight: 400;
+}
+
+.nav-item .nav-link.active {
+  /*background-color: #EE8320;*/
+  border-bottom: black 2px solid;
+}
+
+.navbar {
+  /*background-color: var(--site-color-primary);*/
+  background-color: #FFFFFF;
+  /*var(--site-color-primary);*/
+  padding-top: 0px !important;
+  padding-bottom: 0px !important;
+  /*border-bottom: black 2px solid;*/
+}
+
+.navbar-title {
+  color: black !important;
+  font-weight: 800;
+  font-size: 32px;
+}
+
+.navbar-nav .nav-link {
+    color: black !important;
+}
+
+.navbar #quarto-search.type-overlay .aa-Autocomplete svg.aa-SubmitIcon {
+  color: black;
+}
+
+div.sidebar-item-container .active {
+  /*color: #0047ab;*/
+  color: #6699ff;
+  color: #5dba17;
+  color: #4D9089 !important;
+  font-weight: 600;
+}
+
+.sidebar nav[role=doc-toc] ul>li>a.active, .sidebar nav[role=doc-toc] ul>li>ul>li>a.active
+{
+  color: black !important;
+  /*color: #4D9089 !important;*/
+  border-left: 2px solid #4D9089 !important;
+}
+
+.sidebar nav[role=doc-toc]>ul a {
+  border-left: 2px solid white;
+}
+
+/*
+div.sidebar-item-container .active {
+  color: black;
+  background-color: var(--site-color-secondary);
+}
+
+.sidebar nav[role=doc-toc] ul>li>a.active {
+    border-left: 1px solid var(--site-color-secondary);
+    color: var(--site-color-secondary) !important;
+}
+*/
+
+.sidebar-item-container .text-start {
+  font-weight: 600;
+  font-size: 14.4px !important;
+}
+
+.sidebar-item-text {
+  /*color: rgba(60, 60, 60, 0.7);*/
+  font-weight: 500;
+  font-size: 14px;
+  line-height: 22px;
+}
+
+.sidebar-item-section {
+  padding-top: 16px;
+}
+
+.sidebar-section {
+  padding-left: 0px !important;
+}
+
+.dataframe {
+  font-size: 14px;
+}
+
+.dataframe, .dataframe table {
+  width: inherit;
+}
+
+/*
+.dataframe tbody tr th:only-of-type {
+    vertical-align: middle;
+}
+
+.dataframe tbody tr th {
+    vertical-align: top;
+}
+
+.dataframe thead th {
+    text-align: right;
+}
+*/
+
+
+
+
+/* INDEX PAGE ------------------------------------------ */
+
+
+
+
+/*
+ * Buttons
+*/
+
+.btn-action {
+  min-width: 165px;
+  border-radius: 30px;
+  border: none;
+}
+
+/* content block */
+
+.content-block {
+  padding-top: 20px;
+  padding-bottom: 10px;
+  margin-left: 30px;
+  margin-right: 30px;
+}
+
+
+@media(min-width: 900px) {
+.content-block {
+  margin-left: 50px;
+  margin-right: 50px;
+}
+}
+
+@media (min-width: 1200px) {
+.content-block {
+  max-width: 1100px;
+  margin-left: auto;
+  margin-right: auto;
+}
+}
+
+.feature-blocks .grid {
+  padding-top: 20px;
+  padding-bottom: 20px;
+}
+
+.hero-banner {
+  background-image: url('./assets/siuba-banner.svg');
+  background-size: auto 100%;
+  background-position: center;
+  height: 400px;
+}
+
+.hero-github-links {
+  padding-top: 30px;
+}
+
+.hero-title {
+  font-size: 64px;
+  background-color: #FFFFFF77;
+}
+
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,7 @@ dev-dependencies = [`
`32`	`32`	`"patsy",`
`33`	`33`	`"pytest >=8.1.1,<9",`
`34`	`34`	`"pytest-xdist >=3.6.1",`
`35`		`- "ruff>=0.6.4",`
`36`		`- "quartodoc"`
	`35`	`+ "ruff>=0.6.4"`
`37`	`36`	`]`
`38`	`37`
`39`	`38`