pyjanitor icon indicating copy to clipboard operation
pyjanitor copied to clipboard

[DOC/ENH] changing contribution documentation based on feedback from sprinters

Open zbarry opened this issue 6 years ago • 6 comments

in nbconvert_config.py. Is there a way to automagically set this up for people (like me 🤔 )?

zbarry avatar May 12 '19 02:05 zbarry

A makefile command, perhaps?

ericmjl avatar May 12 '19 02:05 ericmjl

Sure. Could get fancy and make the existence of the kernelspec a target of the notebooks target so it is set up the first time you run it.

zbarry avatar May 12 '19 02:05 zbarry

The code to install a kernelspec is:

conda activate pyjanitor-dev
python -m ipykernel install --user --name pyjanitor-dev --display-name "PyJanitor development"

zbarry avatar Jul 13 '19 23:07 zbarry

It’s now part of the docs, if I remember correctly.

ericmjl avatar Jul 13 '19 23:07 ericmjl

Intention was to put an autoconfig piece in the makefile

zbarry avatar Jul 14 '19 15:07 zbarry

I will be working on this and other changes to documentation on contributing to the project that will probably involve splitting up CONTRIBUTING.rst into separate files. It's pretty monolithic right now, and there are two separate modules really: contribution guidelines and setting up an development environment. This will help make it clearer how to get started developing and then how to contribute those developments.

zbarry avatar Jul 14 '19 15:07 zbarry