Docs via mkdocs (#589)

* mkdocs site * merge with main and update installation * feedback adjustment * rstudio link fix * fix Docs can build step * ignore validation --------- Co-authored-by: vincent d warmerdam <[email protected]>
koaning · Nov 29, 2023 · 2831264 · 2831264
1 parent 4ae226e
commit 2831264
Show file tree

Hide file tree

Showing 204 changed files with 4,935 additions and 8,455 deletions.
diff --git a/.github/workflows/dependencies.yml b/.github/workflows/dependencies.yml
@@ -28,23 +28,23 @@ jobs:
     - name: Run Checks
       run: |
         python tests/scripts/check_pip.py missing cvxpy
-        python tests/scripts/check_pip.py contains scikit-learn
+        python tests/scripts/check_pip.py installed scikit-learn
         python tests/scripts/import_all.py
     - name: Install cvxpy
       run: |
         python -m pip install -e ".[cvxpy]"
     - name: Run Checks
       run: |
-        python tests/scripts/check_pip.py contains cvxpy scikit-learn
+        python tests/scripts/check_pip.py installed cvxpy scikit-learn
         python tests/scripts/import_all.py
     - name: Install All
       run: |
         python -m pip install -e ".[all]"
     - name: Run Checks
       run: |
-        python tests/scripts/check_pip.py contains cvxpy scikit-learn
+        python tests/scripts/check_pip.py installed cvxpy formulaic patsy scikit-learn umap-learn
     - name: Docs can Build
       run: |
         sudo apt-get update && sudo apt-get install pandoc
         python -m pip install -e ".[docs]"
-        sphinx-build doc docs
+        mkdocs build
diff --git a/.gitignore b/.gitignore
@@ -117,7 +117,6 @@ dmypy.json
 # editor
 .vscode
 .idea
-docs/
 .DS_Store
 
 # Local Netlify folder

diff --git a/Makefile b/Makefile
@@ -24,8 +24,8 @@ precommit:
 	pre-commit run
 
 docs:
-	rm -rf doc/.ipynb_checkpoints
-	sphinx-build -a -E doc docs
+	pip install -e ".[docs]"
+	mkdocs serve
 
 docs-deploy: docs
 	netlify deploy --dir=docs --prod
@@ -34,7 +34,6 @@ clean:
 	rm -rf .pytest_cache
 	rm -rf build
 	rm -rf dist
-	rm -rf docs
 	rm -rf scikit_lego.egg-info
 	rm -rf .ipynb_checkpoints
 	rm -rf .coverage*

diff --git a/doc/Makefile b/doc/Makefile
diff --git a/doc/_static/css/custom.css b/doc/_static/css/custom.css
diff --git a/doc/_static/decay1.png b/doc/_static/decay1.png
diff --git a/doc/_static/decay2.png b/doc/_static/decay2.png
diff --git a/doc/_static/grouped-chick-1.png b/doc/_static/grouped-chick-1.png
diff --git a/doc/_static/grouped-chick-2.png b/doc/_static/grouped-chick-2.png
diff --git a/doc/_static/grouped-chick-3.png b/doc/_static/grouped-chick-3.png
diff --git a/doc/_static/grouped-model.png b/doc/_static/grouped-model.png
diff --git a/doc/_static/lowess-base.png b/doc/_static/lowess-base.png
diff --git a/doc/_static/lowess-pred-1.gif b/doc/_static/lowess-pred-1.gif
diff --git a/doc/_static/lowess-pred-2.gif b/doc/_static/lowess-pred-2.gif
diff --git a/doc/_static/lowess-rolling.gif b/doc/_static/lowess-rolling.gif
diff --git a/doc/_static/lowess-span-1.png b/doc/_static/lowess-span-1.png
diff --git a/doc/_static/lowess-span-2.png b/doc/_static/lowess-span-2.png
diff --git a/doc/_static/lowess-two-predictions.gif b/doc/_static/lowess-two-predictions.gif
diff --git a/doc/_static/naive-bayes-1.png b/doc/_static/naive-bayes-1.png
diff --git a/doc/_static/naive-bayes-2.png b/doc/_static/naive-bayes-2.png
diff --git a/doc/_static/naive-bayes-22.png b/doc/_static/naive-bayes-22.png
diff --git a/doc/_static/naive-bayes-3.png b/doc/_static/naive-bayes-3.png
diff --git a/doc/_static/outlier-clf.png b/doc/_static/outlier-clf.png
diff --git a/doc/_static/outlier-mixture-stddev.png b/doc/_static/outlier-mixture-stddev.png
diff --git a/doc/_static/outlier-mixture-threshold.png b/doc/_static/outlier-mixture-threshold.png
diff --git a/doc/_static/outlier-mixture.png b/doc/_static/outlier-mixture.png
diff --git a/doc/_static/skewed-data.png b/doc/_static/skewed-data.png
diff --git a/doc/_static/threshold-results.png b/doc/_static/threshold-results.png
diff --git a/doc/_static/timegapsplit.png b/doc/_static/timegapsplit.png
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
diff --git a/doc/api/base.rst b/doc/api/base.rst
diff --git a/doc/api/common.rst b/doc/api/common.rst
diff --git a/doc/api/datasets.rst b/doc/api/datasets.rst
diff --git a/doc/api/decomposition.rst b/doc/api/decomposition.rst
diff --git a/doc/api/dummy.rst b/doc/api/dummy.rst
diff --git a/doc/api/linear_model.rst b/doc/api/linear_model.rst
diff --git a/doc/api/meta.rst b/doc/api/meta.rst
diff --git a/doc/api/metrics.rst b/doc/api/metrics.rst
diff --git a/doc/api/mixture.rst b/doc/api/mixture.rst
diff --git a/doc/api/model_selection.rst b/doc/api/model_selection.rst
diff --git a/doc/api/modules.rst b/doc/api/modules.rst
diff --git a/doc/api/naive_bayes.rst b/doc/api/naive_bayes.rst
diff --git a/doc/api/pandas_utils.rst b/doc/api/pandas_utils.rst
diff --git a/doc/api/pipeline.rst b/doc/api/pipeline.rst
diff --git a/doc/api/preprocessing.rst b/doc/api/preprocessing.rst
-Original file line number
+Diff line change
@@ Expand Up / @@ -117,7 +117,6 @@ dmypy.json @@
     # editor
     .vscode
     .idea
-    docs/
     .DS_Store
     # Local Netlify folder
@@ Expand Down @@