[INF] Set independent environment for building documentation (#1141)

* Create mkdocs/environment.yaml

* correct commands

* correct file path

* Try to remove ipython

* Update CHANGELOG.md

* correct word

Co-authored-by: Eric Ma <[email protected]>

Co-authored-by: Eric Ma <[email protected]>

Author: Zeroto521

.github/workflows/docs-preview.yml

@@ -22,16 +22,12 @@ jobs:
         with:
           auto-update-conda: true
           miniforge-variant: Mambaforge
-          channels: conda-forge
-          activate-environment: pyjanitor-dev
-          environment-file: environment-dev.yml
+          environment-file: mkdocs/environment.yaml
           use-mamba: true
 
       - name: Build docs
         run: |
-          conda activate pyjanitor-dev
-          python -m ipykernel install --user --name pyjanitor-dev
-          pip install -e .
+          pip install .
           mkdocs build
 
       - name: Deploy docs preview to Netlify

CHANGELOG.md

@@ -16,6 +16,7 @@
 -   [ENH] `dropna` parameter added to `pivot_longer`. Issue #1132 @samukweku
 -   [INF] Update `mkdocstrings` version and to fit its new coming features. PR #1138 @Zeroto521
 -   [BUG] Force `math.softmax` returning `Series`. PR #1139 @Zeroto521
+-   [INF] Set independent environment for building documentation. PR #1141 @Zeroto521
 
 ## [v0.23.1] - 2022-05-03
 

mkdocs/environment.yaml

@@ -0,0 +1,23 @@
+name: pyjanitor-doc
+channels:
+  - conda-forge
+dependencies:
+  - python
+  # required
+  - pandas
+  - pandas-flavor
+  - multipledispatch
+  - scipy
+  # optional
+  - biopython
+  - natsort
+  - pyspark>=3.2.0
+  - rdkit
+  - tqdm
+  - unyt
+  - xarray
+  - numba
+  # doc
+  - mkdocs
+  - mkdocs-material
+  - mkdocstrings-python