docs: Add comprehensive Jupyter Notebooks documentation#4971
Open
docs: Add comprehensive Jupyter Notebooks documentation#4971
Conversation
Closes psf#4967 - Created dedicated jupyter_notebooks.md page consolidating all Jupyter info - Added to usage_and_configuration navigation - Covers installation, usage, configuration, pre-commit, and troubleshooting - Documentation builds successfully with strict mode (-W flag)"
Author
|
@cobaltt7 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #4967
This PR consolidates scattered Jupyter Notebook documentation into a comprehensive, dedicated page at
docs/usage_and_configuration/jupyter_notebooks.md.Problem: Currently, Jupyter-related information is scattered across multiple documentation files (README.md, getting_started.md, FAQ, source_version_control.md), making it difficult for users to find complete information about using Black with Jupyter Notebooks.
Solution: Created a single authoritative page that covers:
pip install "black[jupyter]"--python-cell-magics,--skip-magic-trailing-comma)black-jupyterhookTesting: Documentation builds successfully with strict mode:
Checklist - did you ...
--previewstyle, following the stability policy?CHANGES.mdif necessary?sphinx-build -W