Docs: Add comprehensive Jupyter Notebooks documentation page#4985
Closed
Docs: Add comprehensive Jupyter Notebooks documentation page#4985
Conversation
Contributor
Author
|
Friendly ping - any chance someone could take a look at this when they get a chance? Happy to make any changes if needed. |
4 tasks
Consolidates all Jupyter-related information into a dedicated documentation page that covers installation, usage, configuration, and troubleshooting. This addresses issue psf#4967 by providing a central location for all Jupyter information rather than having it scattered across multiple docs. Changes: - Create new jupyter_notebooks.md with comprehensive coverage: - Installation instructions with pip and pipx - Basic usage and command-line options - Configuration via pyproject.toml - Detailed explanation of what gets formatted - Pre-commit and editor integration - Troubleshooting section with examples - Update getting_started.md to reference the new page instead of inline instructions - Update usage_and_configuration/index.md to include the new page in the table of contents - Update faq.md to link to the new comprehensive documentation Fixes psf#4967
for more information, see https://pre-commit.ci
acc6ff4 to
b667257
Compare
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
2 participants
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.
Summary
This PR adds a dedicated documentation page for Jupyter Notebooks usage, consolidating all Jupyter-related information that was previously scattered across multiple documentation files.
Fixes #4967
Closes #4971
Closes #5009
Changes
New file:
docs/usage_and_configuration/jupyter_notebooks.md- A comprehensive guide covering:--ipynb,--python-cell-magics)pyproject.tomlUpdated files:
docs/getting_started.md- Replaced inline Jupyter installation instructions with a link to the new dedicated pagedocs/usage_and_configuration/index.md- Added the new Jupyter page to the table of contentsdocs/faq.md- Added a reference to the comprehensive Jupyter documentationMotivation
As noted in issue #4967, Black's Jupyter support documentation was scattered across multiple pages. Users looking for information about using Black with Jupyter Notebooks had to search through:
This PR creates a single, comprehensive resource that covers all aspects of Jupyter Notebook formatting with Black, making it much easier for users to find the information they need.
Testing