From 925d04a15dd6e22f846fba626adb79cdb3814efb Mon Sep 17 00:00:00 2001 From: Zero Date: Sat, 6 Aug 2022 16:26:07 +0800 Subject: [PATCH 1/6] update mkdocstrings --- environment-dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/environment-dev.yml b/environment-dev.yml index 40854788c..ad39ce569 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -22,7 +22,7 @@ dependencies: - make - mkdocs - mkdocs-material - - mkdocstrings<0.18.0 + - mkdocstrings - missingno - multipledispatch - mypy From e22a0b1775ccaade4df5e5836fb14c272a477f02 Mon Sep 17 00:00:00 2001 From: Zero Date: Sat, 6 Aug 2022 16:26:52 +0800 Subject: [PATCH 2/6] install `mkdocstrings[python]` via pip not conda --- environment-dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/environment-dev.yml b/environment-dev.yml index ad39ce569..ae51eb4eb 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -22,7 +22,6 @@ dependencies: - make - mkdocs - mkdocs-material - - mkdocstrings - missingno - multipledispatch - mypy @@ -54,3 +53,4 @@ dependencies: - xorg-libxrender - pip: - mknotebooks + - mkdocstrings[python] From 32edd83b662aa3fd516d114f36c585e8e2f90db6 Mon Sep 17 00:00:00 2001 From: Zero Date: Sat, 6 Aug 2022 16:19:04 +0800 Subject: [PATCH 3/6] fix "ValueError: 'restructured-text' is not a valid Parser" follow https://github.com/mkdocstrings/mkdocstrings/issues/237#issuecomment-1194029459 --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 3c95832c1..7d0c2dc63 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,7 +46,7 @@ plugins: show_source: true # https://github.com/mkdocstrings/mkdocstrings/issues/278#issuecomment-831411193 selection: - docstring_style: restructured-text + docstring_style: sphinx # custom_templates: templates watch: - janitor/ From 703826375ae19cddeb42d81268869d612a5824c2 Mon Sep 17 00:00:00 2001 From: Zero Date: Sat, 6 Aug 2022 16:41:48 +0800 Subject: [PATCH 4/6] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cf6e390c5..efca71ca9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ - [ENH] Add `names_expand` and `index_expand` parameters to `pivot_wider` for exposing missing categoricals. Issue #1108 @samukweku - [ENH] Add fix for slicing error when selecting columns in `pivot_wider`. Issue #1134 @samukweku - [ENH] `dropna` parameter added to `pivot_longer`. Issue #1132 @samukweku +- [INF] Update `mkdocstrings` version and to fit its new coming features. PR #1138 @Zeroto521 ## [v0.23.1] - 2022-05-03 From 021aab351e62e144b8177c731eddd67407a246b4 Mon Sep 17 00:00:00 2001 From: Zero Date: Sat, 6 Aug 2022 16:43:00 +0800 Subject: [PATCH 5/6] Correct link --- AUTHORS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index b67f0060d..d457f72ad 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -100,7 +100,7 @@ Contributors - [@MollyCroke](https://github.com/MollyCroke) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3AMollyCroke) - [@ericclessantostv](https://github.com/ericlessantostv) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Aericclessantostv) - [@fireddd](https://github.com/fireddd) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Afireddd) -- [@Zeroto521](https://github.com/Zeroto521) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Zeroto521) +- [@Zeroto521](https://github.com/Zeroto521) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/pulls?q=is%3Aclosed+mentions%3Azeroto521) - [@thatlittleboy](https://github.com/thatlittleboy) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Athatlittleboy) - [@robertmitchellv](https://github.com/robertmitchellv) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Arobertmitchellv) - [@Econundrums](https://github.com/Econundrums) | [contributions](https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3AEconundrums) From 62d50b820faf04292e09c4c0bf60f61c0c760922 Mon Sep 17 00:00:00 2001 From: Zero Date: Sun, 7 Aug 2022 09:33:29 +0800 Subject: [PATCH 6/6] directly install mkdocstrings-python via conda --- environment-dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/environment-dev.yml b/environment-dev.yml index ae51eb4eb..b2ff0c6f8 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -22,6 +22,7 @@ dependencies: - make - mkdocs - mkdocs-material + - mkdocstrings-python - missingno - multipledispatch - mypy @@ -53,4 +54,3 @@ dependencies: - xorg-libxrender - pip: - mknotebooks - - mkdocstrings[python]