Hook with pre-commit install, you can fix everything up using If you have already committed files before setting up the pre-commit Into your text editor to format code automatically. Which should run any autoformatting on your codeĪnd tell you about any errors it couldn't fix automatically. You can invoke the pre-commit hook by hand at any time with: pre-commit run The pre-commit hook should take care of how it should look. Need to worry too much about your code style. Jupyter-client has adopted automatic code formatting so you shouldn't Point your browser to the following URL to access the generated documentation:įile:///my/projects/jupyter_client/docs/_build/html/index.html Contributing The following commands build the documentation in HTML format and check for broken links: cd /my/projects/jupyter_client/docs/ You'll also need the make command.įor a minimal Sphinx installation to process the Jupyter Client docs, execute: pip install "." Instructions for setting up Sphinx with a selection of optional modules are in the Documentation Guide. The documentation of Jupyter Client is generated from the files in docs/ using Sphinx. During development, you can pass filenames to pytest, and it will execute only those tests. The last command runs the test suite to verify the setup. Clone the Jupyter Client git repository to your computer, for example in /my/project/jupyter_client cd /my/projects/Īnd download the dependencies of code and test suite by executing: cd /my/projects/jupyter_client/ You'll need Python and pip on the search path. The limited instructions below for setting up a development environment are for your convenience. The Jupyter Contributor Guides provide extensive information on contributing code or documentation to Jupyter projects. It also provides the jupyter kernelspec entrypointįor installing kernelspecs for use with Jupyter frontends. It also provides client and kernel management APIs for working with kernels. Jupyter_client contains the reference implementation of the Jupyter protocol.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |