Skip to content

[INF] Set independent environment for building documentation #1141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 11, 2022
Merged

[INF] Set independent environment for building documentation #1141

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e80f6cc
Create mkdocs/environment.yaml
Zeroto521 Aug 10, 2022
9a539d6
correct commands
Zeroto521 Aug 10, 2022
fac2cff
correct file path
Zeroto521 Aug 10, 2022
3983770
Try to remove ipython
Zeroto521 Aug 10, 2022
933df1b
Update CHANGELOG.md
Zeroto521 Aug 10, 2022
933bcf8
correct word
Zeroto521 Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions .github/workflows/docs-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,12 @@ jobs:
with:
auto-update-conda: true
miniforge-variant: Mambaforge
channels: conda-forge
activate-environment: pyjanitor-dev
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The value of channels and activate-environment use the variable of mkdocs/environment.yml

environment-file: environment-dev.yml
environment-file: mkdocs/environment.yaml
use-mamba: true

- name: Build docs
run: |
conda activate pyjanitor-dev
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default will activate that env

python -m ipykernel install --user --name pyjanitor-dev
pip install -e .
pip install .
mkdocs build

- name: Deploy docs preview to Netlify
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 indenpend environment for building documentation. PR #1141 @Zeroto521

## [v0.23.1] - 2022-05-03

Expand Down
23 changes: 23 additions & 0 deletions mkdocs/environment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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