From 371838e48a9fdd35ad40e478528422d1be27aedf Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 09:11:08 +1100 Subject: [PATCH 01/25] Fix excess whitespace in streaming output from code cells - Add CSS rule to remove top margin from consecutive stream outputs - Fixes issue #325 where multiple print statements in loops created excessive spacing between output lines - Rule only applies to consecutive .output.stream elements to maintain spacing when appropriate while eliminating gaps in streaming output --- src/quantecon_book_theme/assets/styles/index.scss | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 6531dc6..c5c1e66 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -295,6 +295,13 @@ body { .cell_output .output.stderr { border: 0rem; } + + // Fix excess spacing in streaming output (Issue #325) + // When multiple print statements generate consecutive stream outputs, + // remove the top margin to prevent large gaps between lines + .cell_output .output.stream + .output.stream { + margin-top: 0; + } } } From b8c9bc443944b339f81d0ef3d83d82f9257061a7 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 09:14:07 +1100 Subject: [PATCH 02/25] Add test for streaming output spacing - Add ntbk_streaming.ipynb test notebook with multiple print statements - Add test_streaming_output_spacing test case to verify structure - Include streaming notebook in test site toctree - Tests verify fix for issue #325 --- tests/sites/base/section1/index.md | 1 + .../sites/base/section1/ntbk_streaming.ipynb | 79 +++++++++++++++++++ tests/test_build.py | 29 +++++++ tests/test_build/test_build_book.html | 11 ++- 4 files changed, 117 insertions(+), 3 deletions(-) create mode 100644 tests/sites/base/section1/ntbk_streaming.ipynb diff --git a/tests/sites/base/section1/index.md b/tests/sites/base/section1/index.md index 6958b84..a2dbb87 100644 --- a/tests/sites/base/section1/index.md +++ b/tests/sites/base/section1/index.md @@ -3,6 +3,7 @@ ```{toctree} page1 ntbk +ntbk_streaming ntbkmd ntbk_octave ntbk_julia diff --git a/tests/sites/base/section1/ntbk_streaming.ipynb b/tests/sites/base/section1/ntbk_streaming.ipynb new file mode 100644 index 0000000..dde25f8 --- /dev/null +++ b/tests/sites/base/section1/ntbk_streaming.ipynb @@ -0,0 +1,79 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Test Streaming Output\n", + "\n", + "This notebook tests streaming output from multiple print statements." + ] + }, + { + "cell_type": "code", + "execution_count": 1, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Error at iteration 25 is 40.0.\n", + "Error at iteration 50 is 20.0.\n", + "Error at iteration 75 is 13.333333333333334.\n" + ] + } + ], + "source": [ + "# Test with streaming output from loop\n", + "for i in [25, 50, 75]:\n", + " error = 100 / (i / 10)\n", + " print(f\"Error at iteration {i} is {error}.\")" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Line 1\n", + "Line 2\n", + "Line 3\n", + "Line 4\n", + "Line 5\n" + ] + } + ], + "source": [ + "# Test with multiple consecutive print statements\n", + "for i in range(1, 6):\n", + " print(f\"Line {i}\")" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.9.0" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/tests/test_build.py b/tests/test_build.py index ab996cd..1821636 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -422,3 +422,32 @@ def test_qetheme_code_style(sphinx_build): # String "true" should be treated as True assert "use-pygments-style" not in body_tag.get("class", []) sphinx_build.clean() + + +def test_streaming_output_spacing(sphinx_build): + """Test that streaming output from multiple print statements has correct spacing. + + This test verifies the fix for issue #325 where consecutive stream outputs + should not have excessive spacing between them. + """ + sphinx_build.copy() + sphinx_build.build() + + # Get the streaming output notebook page + streaming_html = sphinx_build.get("section1/ntbk_streaming.html") + + # Find all stream output divs + stream_outputs = streaming_html.find_all("div", class_="output") + stream_divs = [ + div for div in stream_outputs + if "stream" in div.get("class", []) + ] + + # Should have stream outputs from the test notebook + assert len(stream_divs) > 0, "Should have streaming output elements" + + # The HTML should be built successfully with the notebook included + # The actual spacing fix is in the CSS, so we verify the structure is correct + assert streaming_html is not None + + sphinx_build.clean() diff --git a/tests/test_build/test_build_book.html b/tests/test_build/test_build_book.html index f9af32a..709992b 100644 --- a/tests/test_build/test_build_book.html +++ b/tests/test_build/test_build_book.html @@ -41,19 +41,24 @@ 3.2. A test notebook +
  • + + 3.3. Test Streaming Output + +
  • - 3.3. Section 1 page1 + 3.4. Section 1 page1
  • - 3.4. Octave + 3.5. Octave
  • - 3.5. Julia + 3.6. Julia
    • From 9e744a2494713307a5011f7446fe310d46a4c40e Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 09:31:12 +1100 Subject: [PATCH 03/25] fix: pre-commit --- tests/test_build.py | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/tests/test_build.py b/tests/test_build.py index 1821636..6021ceb 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -426,28 +426,25 @@ def test_qetheme_code_style(sphinx_build): def test_streaming_output_spacing(sphinx_build): """Test that streaming output from multiple print statements has correct spacing. - + This test verifies the fix for issue #325 where consecutive stream outputs should not have excessive spacing between them. """ sphinx_build.copy() sphinx_build.build() - + # Get the streaming output notebook page streaming_html = sphinx_build.get("section1/ntbk_streaming.html") - + # Find all stream output divs stream_outputs = streaming_html.find_all("div", class_="output") - stream_divs = [ - div for div in stream_outputs - if "stream" in div.get("class", []) - ] - + stream_divs = [div for div in stream_outputs if "stream" in div.get("class", [])] + # Should have stream outputs from the test notebook assert len(stream_divs) > 0, "Should have streaming output elements" - + # The HTML should be built successfully with the notebook included # The actual spacing fix is in the CSS, so we verify the structure is correct assert streaming_html is not None - + sphinx_build.clean() From fa7306404d422054f51c03d4c41df05073bb4e7b Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 11:01:25 +1100 Subject: [PATCH 04/25] Fix CSS placement: Move streaming output fix outside dark-theme block --- src/quantecon_book_theme/assets/styles/index.scss | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index c5c1e66..2cfc81c 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -295,16 +295,16 @@ body { .cell_output .output.stderr { border: 0rem; } - - // Fix excess spacing in streaming output (Issue #325) - // When multiple print statements generate consecutive stream outputs, - // remove the top margin to prevent large gaps between lines - .cell_output .output.stream + .output.stream { - margin-top: 0; - } } } +// Fix excess spacing in streaming output (Issue #325) +// When multiple print statements generate consecutive stream outputs, +// remove the top margin to prevent large gaps between lines +.cell_output .output.stream + .output.stream { + margin-top: 0; +} + .section, .reference, .math { From 923d57c8228c1512620b738f3ed0eb8a483960fc Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 11:50:46 +1100 Subject: [PATCH 05/25] Add !important to override MyST-NB default margin --- src/quantecon_book_theme/assets/styles/index.scss | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 2cfc81c..3771af5 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -301,8 +301,9 @@ body { // Fix excess spacing in streaming output (Issue #325) // When multiple print statements generate consecutive stream outputs, // remove the top margin to prevent large gaps between lines +// Using !important to override MyST-NB's default margin-top: 1em .cell_output .output.stream + .output.stream { - margin-top: 0; + margin-top: 0 !important; } .section, From 3fc1a45ec711f20397dd2b8a95833f7f1a280172 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 12:57:51 +1100 Subject: [PATCH 06/25] Update test notebook with proper streaming output structure - Updated ntbk_streaming.ipynb to have multiple separate stream outputs per cell (3 outputs in first cell, 5 in second) to match real-world streaming behavior - Enhanced test to verify we have multiple consecutive stream outputs as siblings - This properly tests the CSS fix that removes spacing between adjacent .output.stream elements --- .../assets/styles/index.scss | 6 +++ .../sites/base/section1/ntbk_streaming.ipynb | 52 ++++++++++++++++--- tests/test_build.py | 18 +++++-- 3 files changed, 64 insertions(+), 12 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 3771af5..5b0b16b 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -304,6 +304,12 @@ body { // Using !important to override MyST-NB's default margin-top: 1em .cell_output .output.stream + .output.stream { margin-top: 0 !important; + + // Also remove margin from the .highlight div inside consecutive stream outputs + .highlight { + margin-top: 0 !important; + margin-bottom: 0 !important; + } } .section, diff --git a/tests/sites/base/section1/ntbk_streaming.ipynb b/tests/sites/base/section1/ntbk_streaming.ipynb index dde25f8..aa32a1f 100644 --- a/tests/sites/base/section1/ntbk_streaming.ipynb +++ b/tests/sites/base/section1/ntbk_streaming.ipynb @@ -18,14 +18,27 @@ "name": "stdout", "output_type": "stream", "text": [ - "Error at iteration 25 is 40.0.\n", - "Error at iteration 50 is 20.0.\n", + "Error at iteration 25 is 40.0.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Error at iteration 50 is 20.0.\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ "Error at iteration 75 is 13.333333333333334.\n" ] } ], "source": [ "# Test with streaming output from loop\n", + "# Each print statement creates a separate stream output\n", "for i in [25, 50, 75]:\n", " error = 100 / (i / 10)\n", " print(f\"Error at iteration {i} is {error}.\")" @@ -40,16 +53,41 @@ "name": "stdout", "output_type": "stream", "text": [ - "Line 1\n", - "Line 2\n", - "Line 3\n", - "Line 4\n", + "Line 1\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Line 2\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Line 3\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Line 4\n" + ] + }, + { + "name": "stdout", + "output_type": "stream", + "text": [ "Line 5\n" ] } ], "source": [ "# Test with multiple consecutive print statements\n", + "# Each creates a separate stream output\n", "for i in range(1, 6):\n", " print(f\"Line {i}\")" ] @@ -71,7 +109,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.0" + "version": "3.12.0" } }, "nbformat": 4, diff --git a/tests/test_build.py b/tests/test_build.py index 6021ceb..88c2a75 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -440,11 +440,19 @@ def test_streaming_output_spacing(sphinx_build): stream_outputs = streaming_html.find_all("div", class_="output") stream_divs = [div for div in stream_outputs if "stream" in div.get("class", [])] - # Should have stream outputs from the test notebook - assert len(stream_divs) > 0, "Should have streaming output elements" + # Should have multiple stream outputs from the test notebook + # First cell has 3 stream outputs, second has 5 = 8 total + assert len(stream_divs) >= 8, f"Should have at least 8 streaming output elements, found {len(stream_divs)}" - # The HTML should be built successfully with the notebook included - # The actual spacing fix is in the CSS, so we verify the structure is correct - assert streaming_html is not None + # Verify we have consecutive streaming outputs (adjacent siblings) + # Find the cell_output container + cell_output = streaming_html.find("div", class_="cell_output") + assert cell_output is not None, "Should have cell_output container" + # Get all direct children that are stream outputs + children = [child for child in cell_output.children if child.name == "div" and "stream" in child.get("class", [])] + assert len(children) >= 2, "Should have at least 2 consecutive stream outputs as siblings" + + # The actual spacing fix is in the CSS (.cell_output .output.stream + .output.stream) + # We verify the HTML structure supports the fix sphinx_build.clean() From 9f52b9ea23b0dc0afa7f8a1da16c87fe176a1a37 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 12:59:00 +1100 Subject: [PATCH 07/25] fix: pre-commit --- src/quantecon_book_theme/assets/styles/index.scss | 2 +- tests/test_build.py | 14 +++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 5b0b16b..7cfe922 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -304,7 +304,7 @@ body { // Using !important to override MyST-NB's default margin-top: 1em .cell_output .output.stream + .output.stream { margin-top: 0 !important; - + // Also remove margin from the .highlight div inside consecutive stream outputs .highlight { margin-top: 0 !important; diff --git a/tests/test_build.py b/tests/test_build.py index 88c2a75..960efae 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -442,7 +442,9 @@ def test_streaming_output_spacing(sphinx_build): # Should have multiple stream outputs from the test notebook # First cell has 3 stream outputs, second has 5 = 8 total - assert len(stream_divs) >= 8, f"Should have at least 8 streaming output elements, found {len(stream_divs)}" + assert ( + len(stream_divs) >= 8 + ), f"Should have at least 8 streaming output elements, found {len(stream_divs)}" # Verify we have consecutive streaming outputs (adjacent siblings) # Find the cell_output container @@ -450,8 +452,14 @@ def test_streaming_output_spacing(sphinx_build): assert cell_output is not None, "Should have cell_output container" # Get all direct children that are stream outputs - children = [child for child in cell_output.children if child.name == "div" and "stream" in child.get("class", [])] - assert len(children) >= 2, "Should have at least 2 consecutive stream outputs as siblings" + children = [ + child + for child in cell_output.children + if child.name == "div" and "stream" in child.get("class", []) + ] + assert ( + len(children) >= 2 + ), "Should have at least 2 consecutive stream outputs as siblings" # The actual spacing fix is in the CSS (.cell_output .output.stream + .output.stream) # We verify the HTML structure supports the fix From 4327e267748188cd8a97ec96d586de0686831fde Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 13:33:00 +1100 Subject: [PATCH 08/25] Fix: Remove margins from pre elements in streaming output The .highlight pre elements had 0.25rem margins that were creating spacing between consecutive stream outputs. Added nested pre rule to remove these margins along with the .highlight margins. --- src/quantecon_book_theme/assets/styles/index.scss | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 7cfe922..262fa40 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -309,6 +309,12 @@ body { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; + + // Remove margin from the pre element inside .highlight + pre { + margin-top: 0 !important; + margin-bottom: 0 !important; + } } } From 8c26ab8b2135d98549ca37074bc820541f47bfe3 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 13:34:31 +1100 Subject: [PATCH 09/25] fix: pre-commit --- src/quantecon_book_theme/assets/styles/index.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 262fa40..004bfb6 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -309,7 +309,7 @@ body { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; - + // Remove margin from the pre element inside .highlight pre { margin-top: 0 !important; From 3213b8f987d9a1239fe734d1c1f01e2661a3b1c8 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 14:07:16 +1100 Subject: [PATCH 10/25] Fix: Use shorthand margin property to override _syntax.scss The _syntax.scss file uses 'margin: 0.25rem' (shorthand) on .highlight pre, which was overriding our longhand margin-top and margin-bottom declarations. Changed to use shorthand 'margin: 0 !important' to properly override. --- src/quantecon_book_theme/assets/styles/index.scss | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 004bfb6..85778b0 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -309,16 +309,14 @@ body { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; - + // Remove margin from the pre element inside .highlight + // Using shorthand 'margin' to override any shorthand declarations pre { - margin-top: 0 !important; - margin-bottom: 0 !important; + margin: 0 !important; } } -} - -.section, +}.section, .reference, .math { scroll-margin-top: 60px; From 89c7190d4d24d6e7a48da9cc32c915f630e9bf3d Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 14:08:10 +1100 Subject: [PATCH 11/25] Fix: Add missing line break after closing brace The closing brace for the streaming output fix was immediately followed by the .section selector without separation, creating invalid SCSS syntax. --- src/quantecon_book_theme/assets/styles/index.scss | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 85778b0..f193313 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -316,7 +316,9 @@ body { margin: 0 !important; } } -}.section, +} + +.section, .reference, .math { scroll-margin-top: 60px; From 0eba0f524aee6af16feed00c81107c71e4d13d09 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 14:09:28 +1100 Subject: [PATCH 12/25] fix: pre-commit --- src/quantecon_book_theme/assets/styles/index.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index f193313..fdb288e 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -309,7 +309,7 @@ body { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; - + // Remove margin from the pre element inside .highlight // Using shorthand 'margin' to override any shorthand declarations pre { From 4fb6c812d109259b9a0747c11bd86792d735550e Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 14:36:45 +1100 Subject: [PATCH 13/25] Fix: Also remove padding from pre elements in streaming output Added padding-top and padding-bottom removal to ensure no spacing between consecutive stream outputs. --- src/quantecon_book_theme/assets/styles/index.scss | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index fdb288e..45ac9bc 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -310,10 +310,12 @@ body { margin-top: 0 !important; margin-bottom: 0 !important; - // Remove margin from the pre element inside .highlight + // Remove margin and padding from the pre element inside .highlight // Using shorthand 'margin' to override any shorthand declarations pre { margin: 0 !important; + padding-top: 0 !important; + padding-bottom: 0 !important; } } } From 5d3c701ceeb1bd490bd92feacaf47eb5a262947c Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 14:37:35 +1100 Subject: [PATCH 14/25] docs: Add pre-commit reminder to copilot instructions Added instruction to always run pre-commit on all files before committing to GitHub to ensure code quality checks pass in CI. --- .github/copilot-instructions.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 87e01f2..4e11f4a 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -80,9 +80,10 @@ src/quantecon_book_theme/ - **Regression tests**: Tests compare generated HTML against golden files in `tests/test_build/` ### Code Quality Workflow -- Always run `pre-commit run --all-files` before committing +- **CRITICAL**: ALWAYS run `pre-commit run --all-files` before committing to GitHub - Pre-commit includes: black (formatting), flake8 (linting), YAML/JSON validation - CI will fail if pre-commit checks don't pass +- If you make changes to Python or SCSS files, run pre-commit before `git commit` ## Troubleshooting @@ -116,10 +117,13 @@ pre-commit install # Development workflow npm run build # Compile assets (2.5-3 seconds, VALIDATED) tox -e docs-live # Live development server (5-10 minutes) -pre-commit run --all-files # Code quality checks (2-5 minutes, VALIDATED) +pre-commit run --all-files # Code quality checks (2-5 minutes, VALIDATED) - RUN BEFORE COMMITTING flake8 src/ # Python linting (few seconds, VALIDATED) black --check src/ # Formatting check (few seconds, VALIDATED) +# Before committing to GitHub +pre-commit run --all-files # CRITICAL: Always run before git commit + # Testing and CI tox # Full test suite (5-15 minutes) tox -e docs-update # Build documentation (5-15 minutes) From 55fc75e15e30faf8fb5fd07ac3666e0ec4d9328f Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 15:02:05 +1100 Subject: [PATCH 15/25] Fix: Add line-height override for streaming output pre elements --- src/quantecon_book_theme/assets/styles/index.scss | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 45ac9bc..ab0d90b 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -310,12 +310,13 @@ body { margin-top: 0 !important; margin-bottom: 0 !important; - // Remove margin and padding from the pre element inside .highlight + // Remove margin, padding, and line-height from the pre element inside .highlight // Using shorthand 'margin' to override any shorthand declarations pre { margin: 0 !important; padding-top: 0 !important; padding-bottom: 0 !important; + line-height: 1 !important; } } } From 0bb95341141966cb141f1d353b2123d6bd3da630 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 15:52:51 +1100 Subject: [PATCH 16/25] Remove line-height override causing scrollbars in streaming output --- src/quantecon_book_theme/assets/styles/index.scss | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index ab0d90b..45ac9bc 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -310,13 +310,12 @@ body { margin-top: 0 !important; margin-bottom: 0 !important; - // Remove margin, padding, and line-height from the pre element inside .highlight + // Remove margin and padding from the pre element inside .highlight // Using shorthand 'margin' to override any shorthand declarations pre { margin: 0 !important; padding-top: 0 !important; padding-bottom: 0 !important; - line-height: 1 !important; } } } From 67596fd0cecff5493128c098e5226f6fc436f61d Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 15:54:59 +1100 Subject: [PATCH 17/25] Apply streaming output spacing fix to all stream elements, not just consecutive ones --- src/quantecon_book_theme/assets/styles/index.scss | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 45ac9bc..3583eac 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -304,14 +304,16 @@ body { // Using !important to override MyST-NB's default margin-top: 1em .cell_output .output.stream + .output.stream { margin-top: 0 !important; +} - // Also remove margin from the .highlight div inside consecutive stream outputs +// For all streaming output elements, minimize internal spacing +.cell_output .output.stream { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; // Remove margin and padding from the pre element inside .highlight - // Using shorthand 'margin' to override any shorthand declarations + // Using shorthand 'margin' to override any shorthand declarations from _syntax.scss pre { margin: 0 !important; padding-top: 0 !important; From 8cc385358ad6ca39e2306c7d76d6f47cd3fde2d3 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 16:13:56 +1100 Subject: [PATCH 18/25] Tighten streaming output spacing with line-height control and full padding removal --- src/quantecon_book_theme/assets/styles/index.scss | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 3583eac..25070fd 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -311,13 +311,15 @@ body { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; + padding-top: 0 !important; + padding-bottom: 0 !important; // Remove margin and padding from the pre element inside .highlight // Using shorthand 'margin' to override any shorthand declarations from _syntax.scss pre { margin: 0 !important; - padding-top: 0 !important; - padding-bottom: 0 !important; + padding: 0 !important; + line-height: 1.2 !important; } } } From 332d98b9ff3843987360f32e17b218213565321e Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 16:23:40 +1100 Subject: [PATCH 19/25] Revert "Tighten streaming output spacing with line-height control and full padding removal" This reverts commit 8cc385358ad6ca39e2306c7d76d6f47cd3fde2d3. --- src/quantecon_book_theme/assets/styles/index.scss | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 25070fd..3583eac 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -311,15 +311,13 @@ body { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; - padding-top: 0 !important; - padding-bottom: 0 !important; // Remove margin and padding from the pre element inside .highlight // Using shorthand 'margin' to override any shorthand declarations from _syntax.scss pre { margin: 0 !important; - padding: 0 !important; - line-height: 1.2 !important; + padding-top: 0 !important; + padding-bottom: 0 !important; } } } From d33b51a14874518f06eda5a0e7424e02d1894bed Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 16:28:12 +1100 Subject: [PATCH 20/25] Achieve zero spacing between streaming output lines with line-height: 1 and overflow: visible --- src/quantecon_book_theme/assets/styles/index.scss | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 3583eac..762147c 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -300,24 +300,25 @@ body { // Fix excess spacing in streaming output (Issue #325) // When multiple print statements generate consecutive stream outputs, -// remove the top margin to prevent large gaps between lines +// remove ALL spacing to display as continuous terminal-style output // Using !important to override MyST-NB's default margin-top: 1em .cell_output .output.stream + .output.stream { margin-top: 0 !important; } -// For all streaming output elements, minimize internal spacing +// For all streaming output elements, eliminate all internal spacing .cell_output .output.stream { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; + padding: 0 !important; - // Remove margin and padding from the pre element inside .highlight - // Using shorthand 'margin' to override any shorthand declarations from _syntax.scss + // Remove all spacing from the pre element to achieve zero-gap display pre { margin: 0 !important; - padding-top: 0 !important; - padding-bottom: 0 !important; + padding: 0 !important; + line-height: 1 !important; + overflow: visible !important; } } } From a32ba289a0c1448bbbdce9f882556fef4a07a1e8 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 16:53:08 +1100 Subject: [PATCH 21/25] Revert "Achieve zero spacing between streaming output lines with line-height: 1 and overflow: visible" This reverts commit d33b51a14874518f06eda5a0e7424e02d1894bed. --- src/quantecon_book_theme/assets/styles/index.scss | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 762147c..3583eac 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -300,25 +300,24 @@ body { // Fix excess spacing in streaming output (Issue #325) // When multiple print statements generate consecutive stream outputs, -// remove ALL spacing to display as continuous terminal-style output +// remove the top margin to prevent large gaps between lines // Using !important to override MyST-NB's default margin-top: 1em .cell_output .output.stream + .output.stream { margin-top: 0 !important; } -// For all streaming output elements, eliminate all internal spacing +// For all streaming output elements, minimize internal spacing .cell_output .output.stream { .highlight { margin-top: 0 !important; margin-bottom: 0 !important; - padding: 0 !important; - // Remove all spacing from the pre element to achieve zero-gap display + // Remove margin and padding from the pre element inside .highlight + // Using shorthand 'margin' to override any shorthand declarations from _syntax.scss pre { margin: 0 !important; - padding: 0 !important; - line-height: 1 !important; - overflow: visible !important; + padding-top: 0 !important; + padding-bottom: 0 !important; } } } From ee075be34fcabca44c1df77cc720290b26ac4ab3 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 16:55:27 +1100 Subject: [PATCH 22/25] Replace CSS workarounds with Sphinx post-transform to merge consecutive streaming outputs This is a cleaner solution that addresses the root cause: - Merges consecutive output.stream containers into single blocks - Eliminates need for complex CSS overrides - More maintainable and robust - Achieves natural terminal-style output without side effects --- src/quantecon_book_theme/__init__.py | 72 +++++++++++++++++++ .../assets/styles/index.scss | 24 ------- 2 files changed, 72 insertions(+), 24 deletions(-) diff --git a/src/quantecon_book_theme/__init__.py b/src/quantecon_book_theme/__init__.py index 13eba97..feb3617 100644 --- a/src/quantecon_book_theme/__init__.py +++ b/src/quantecon_book_theme/__init__.py @@ -7,6 +7,7 @@ from docutils import nodes from sphinx.util import logging +from sphinx.transforms.post_transforms import SphinxPostTransform from bs4 import BeautifulSoup as bs from sphinx.util.fileutil import copy_asset from sphinx.util.osutil import ensuredir @@ -389,6 +390,74 @@ def _string_or_bool(var): return var is None +class MergeStreamOutputs(SphinxPostTransform): + """Merge consecutive streaming outputs into single blocks. + + This fixes issue #325 where MyST-NB creates separate container elements + for each line of streaming output, creating excessive spacing. By merging + consecutive stream outputs into a single element, we achieve natural + terminal-style continuous output without CSS workarounds. + """ + + default_priority = 500 # Run after other transforms + + def run(self, **kwargs): + """Merge consecutive output.stream containers in the doctree.""" + # Find all container nodes with 'cell_output' class + for cell_output in self.document.traverse(nodes.container): + if "cell_output" not in cell_output.get("classes", []): + continue + + # Look for consecutive output.stream children + children = list(cell_output.children) + i = 0 + while i < len(children): + node = children[i] + + # Check if this is an output.stream container + if ( + isinstance(node, nodes.container) + and "output" in node.get("classes", []) + and "stream" in node.get("classes", []) + ): + # Collect all consecutive stream outputs + consecutive_streams = [node] + j = i + 1 + while j < len(children): + next_node = children[j] + if ( + isinstance(next_node, nodes.container) + and "output" in next_node.get("classes", []) + and "stream" in next_node.get("classes", []) + ): + consecutive_streams.append(next_node) + j += 1 + else: + break + + # If we found multiple consecutive streams, merge them + if len(consecutive_streams) > 1: + # Keep the first stream container + first_stream = consecutive_streams[0] + + # Merge content from subsequent streams into the first + for stream in consecutive_streams[1:]: + # Copy all children from subsequent streams + for child in stream.children: + first_stream.append(child.deepcopy()) + # Remove the subsequent stream from parent + cell_output.remove(stream) + + # Update children list after modifications + children = list(cell_output.children) + # Continue from the merged position + i = cell_output.index(first_stream) + 1 + else: + i += 1 + else: + i += 1 + + def setup(app): # Configuration for Juypter Book app.setup_extension("sphinx_book_theme") @@ -396,6 +465,9 @@ def setup(app): app.add_js_file("scripts/jquery.js") app.add_js_file("scripts/_sphinx_javascript_frameworks_compat.js") + # Register post-transform to merge consecutive streaming outputs + app.add_post_transform(MergeStreamOutputs) + app.connect("html-page-context", add_hub_urls) app.connect("builder-inited", add_plugins_list) app.connect("builder-inited", setup_pygments_css) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 3583eac..6531dc6 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -298,30 +298,6 @@ body { } } -// Fix excess spacing in streaming output (Issue #325) -// When multiple print statements generate consecutive stream outputs, -// remove the top margin to prevent large gaps between lines -// Using !important to override MyST-NB's default margin-top: 1em -.cell_output .output.stream + .output.stream { - margin-top: 0 !important; -} - -// For all streaming output elements, minimize internal spacing -.cell_output .output.stream { - .highlight { - margin-top: 0 !important; - margin-bottom: 0 !important; - - // Remove margin and padding from the pre element inside .highlight - // Using shorthand 'margin' to override any shorthand declarations from _syntax.scss - pre { - margin: 0 !important; - padding-top: 0 !important; - padding-bottom: 0 !important; - } - } -} - .section, .reference, .math { From 02000660c8b7017a1a31c9e479d158e029650662 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 17:11:25 +1100 Subject: [PATCH 23/25] Revert to simple CSS-only fix for streaming output spacing The post-transform approach was overly complex and did not work correctly with MyST-NB rendering pipeline. The simple CSS solution using the adjacent sibling selector is sufficient and well-tested. - Removed MergeStreamOutputs post-transform - Restored CSS rule to remove margin-top between consecutive streams - Updated test to verify HTML structure supports CSS fix - All tests passing --- src/quantecon_book_theme/__init__.py | 72 ------------------- .../assets/styles/index.scss | 6 ++ tests/test_build.py | 39 +++++----- 3 files changed, 29 insertions(+), 88 deletions(-) diff --git a/src/quantecon_book_theme/__init__.py b/src/quantecon_book_theme/__init__.py index feb3617..13eba97 100644 --- a/src/quantecon_book_theme/__init__.py +++ b/src/quantecon_book_theme/__init__.py @@ -7,7 +7,6 @@ from docutils import nodes from sphinx.util import logging -from sphinx.transforms.post_transforms import SphinxPostTransform from bs4 import BeautifulSoup as bs from sphinx.util.fileutil import copy_asset from sphinx.util.osutil import ensuredir @@ -390,74 +389,6 @@ def _string_or_bool(var): return var is None -class MergeStreamOutputs(SphinxPostTransform): - """Merge consecutive streaming outputs into single blocks. - - This fixes issue #325 where MyST-NB creates separate container elements - for each line of streaming output, creating excessive spacing. By merging - consecutive stream outputs into a single element, we achieve natural - terminal-style continuous output without CSS workarounds. - """ - - default_priority = 500 # Run after other transforms - - def run(self, **kwargs): - """Merge consecutive output.stream containers in the doctree.""" - # Find all container nodes with 'cell_output' class - for cell_output in self.document.traverse(nodes.container): - if "cell_output" not in cell_output.get("classes", []): - continue - - # Look for consecutive output.stream children - children = list(cell_output.children) - i = 0 - while i < len(children): - node = children[i] - - # Check if this is an output.stream container - if ( - isinstance(node, nodes.container) - and "output" in node.get("classes", []) - and "stream" in node.get("classes", []) - ): - # Collect all consecutive stream outputs - consecutive_streams = [node] - j = i + 1 - while j < len(children): - next_node = children[j] - if ( - isinstance(next_node, nodes.container) - and "output" in next_node.get("classes", []) - and "stream" in next_node.get("classes", []) - ): - consecutive_streams.append(next_node) - j += 1 - else: - break - - # If we found multiple consecutive streams, merge them - if len(consecutive_streams) > 1: - # Keep the first stream container - first_stream = consecutive_streams[0] - - # Merge content from subsequent streams into the first - for stream in consecutive_streams[1:]: - # Copy all children from subsequent streams - for child in stream.children: - first_stream.append(child.deepcopy()) - # Remove the subsequent stream from parent - cell_output.remove(stream) - - # Update children list after modifications - children = list(cell_output.children) - # Continue from the merged position - i = cell_output.index(first_stream) + 1 - else: - i += 1 - else: - i += 1 - - def setup(app): # Configuration for Juypter Book app.setup_extension("sphinx_book_theme") @@ -465,9 +396,6 @@ def setup(app): app.add_js_file("scripts/jquery.js") app.add_js_file("scripts/_sphinx_javascript_frameworks_compat.js") - # Register post-transform to merge consecutive streaming outputs - app.add_post_transform(MergeStreamOutputs) - app.connect("html-page-context", add_hub_urls) app.connect("builder-inited", add_plugins_list) app.connect("builder-inited", setup_pygments_css) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 6531dc6..7bae539 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -298,6 +298,12 @@ body { } } +// Fix excess spacing in streaming output (Issue #325) +// Remove margin between consecutive streaming outputs +.cell_output .output.stream + .output.stream { + margin-top: 0 !important; +} + .section, .reference, .math { diff --git a/tests/test_build.py b/tests/test_build.py index 960efae..c7192c4 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -425,10 +425,11 @@ def test_qetheme_code_style(sphinx_build): def test_streaming_output_spacing(sphinx_build): - """Test that streaming output from multiple print statements has correct spacing. + """Test that streaming output structure supports CSS spacing fix. This test verifies the fix for issue #325 where consecutive stream outputs - should not have excessive spacing between them. + have CSS applied via .cell_output .output.stream + .output.stream selector + to remove excessive spacing. """ sphinx_build.copy() sphinx_build.build() @@ -447,20 +448,26 @@ def test_streaming_output_spacing(sphinx_build): ), f"Should have at least 8 streaming output elements, found {len(stream_divs)}" # Verify we have consecutive streaming outputs (adjacent siblings) - # Find the cell_output container - cell_output = streaming_html.find("div", class_="cell_output") - assert cell_output is not None, "Should have cell_output container" - - # Get all direct children that are stream outputs - children = [ - child - for child in cell_output.children - if child.name == "div" and "stream" in child.get("class", []) - ] + # Find all cell_output containers + cell_outputs = streaming_html.find_all("div", class_="cell_output") + assert len(cell_outputs) >= 2, "Should have at least 2 cells with outputs" + + # At least one cell should have consecutive stream outputs + found_consecutive = False + for cell_output in cell_outputs: + stream_children = [ + child + for child in cell_output.children + if child.name == "div" + and "output" in child.get("class", []) + and "stream" in child.get("class", []) + ] + if len(stream_children) >= 2: + found_consecutive = True + break + assert ( - len(children) >= 2 - ), "Should have at least 2 consecutive stream outputs as siblings" + found_consecutive + ), "Should have at least one cell with consecutive stream outputs" - # The actual spacing fix is in the CSS (.cell_output .output.stream + .output.stream) - # We verify the HTML structure supports the fix sphinx_build.clean() From 4975c07f731adb8b5d6a74e383563d0e96b7f817 Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 17:20:03 +1100 Subject: [PATCH 24/25] Add comprehensive CSS fix for streaming output spacing Removes margin-top between consecutive outputs and eliminates internal spacing from highlight and pre elements --- .../assets/styles/index.scss | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/quantecon_book_theme/assets/styles/index.scss b/src/quantecon_book_theme/assets/styles/index.scss index 7bae539..e48a4c6 100644 --- a/src/quantecon_book_theme/assets/styles/index.scss +++ b/src/quantecon_book_theme/assets/styles/index.scss @@ -299,11 +299,26 @@ body { } // Fix excess spacing in streaming output (Issue #325) -// Remove margin between consecutive streaming outputs +// Remove all spacing between consecutive streaming outputs .cell_output .output.stream + .output.stream { margin-top: 0 !important; } +// Remove internal spacing from all streaming output elements +.cell_output .output.stream { + .highlight { + margin-top: 0 !important; + margin-bottom: 0 !important; + + // Remove margin and padding from pre elements + pre { + margin: 0 !important; + padding-top: 0 !important; + padding-bottom: 0 !important; + } + } +} + .section, .reference, .math { From 4864339a70d32baa5046d05480798355e8c138af Mon Sep 17 00:00:00 2001 From: mmcky Date: Fri, 21 Nov 2025 18:18:38 +1100 Subject: [PATCH 25/25] Stick with CSS-only solution after transform experiments Tried both SphinxPostTransform and SphinxTransform approaches but they don't work with MyST-NB rendering pipeline. The comprehensive CSS solution is proven to work and is simpler to maintain. --- tests/test_build.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/tests/test_build.py b/tests/test_build.py index c7192c4..da47550 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -428,8 +428,7 @@ def test_streaming_output_spacing(sphinx_build): """Test that streaming output structure supports CSS spacing fix. This test verifies the fix for issue #325 where consecutive stream outputs - have CSS applied via .cell_output .output.stream + .output.stream selector - to remove excessive spacing. + have comprehensive CSS applied to remove excessive spacing. """ sphinx_build.copy() sphinx_build.build() @@ -442,17 +441,15 @@ def test_streaming_output_spacing(sphinx_build): stream_divs = [div for div in stream_outputs if "stream" in div.get("class", [])] # Should have multiple stream outputs from the test notebook - # First cell has 3 stream outputs, second has 5 = 8 total assert ( len(stream_divs) >= 8 ), f"Should have at least 8 streaming output elements, found {len(stream_divs)}" # Verify we have consecutive streaming outputs (adjacent siblings) - # Find all cell_output containers cell_outputs = streaming_html.find_all("div", class_="cell_output") assert len(cell_outputs) >= 2, "Should have at least 2 cells with outputs" - # At least one cell should have consecutive stream outputs + # At least one cell should have consecutive stream outputs for CSS to target found_consecutive = False for cell_output in cell_outputs: stream_children = [ @@ -468,6 +465,6 @@ def test_streaming_output_spacing(sphinx_build): assert ( found_consecutive - ), "Should have at least one cell with consecutive stream outputs" + ), "Should have consecutive stream outputs for CSS fix to apply" sphinx_build.clean()