Skip to content

Fix Sphinx documentation build errors #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
RoryBarnes merged 1 commit into from
Jan 3, 2026
Merged

Fix Sphinx documentation build errors #23

RoryBarnes merged 1 commit into from
Jan 3, 2026

Conversation

@RoryBarnes
Copy link
Contributor

@RoryBarnes RoryBarnes commented Jan 3, 2026

Fixed three issues preventing docs from building:

  1. Theme compatibility: Removed html_theme_path pointing to outdated local theme

    • Local sphinx_rtd_theme/ is incompatible with Sphinx 7.x ('style' undefined)
    • Now uses installed sphinx_rtd_theme package from pip

  2. Link reference syntax error in help.rst:18

    • Fixed: '.. BigPlanet:' → '.. _BigPlanet:' (missing underscore)
    • Removed improper indentation

  3. Title underline too short in index.rst:2

    • Extended underline to match title length (7 → 26 characters)

All errors resolved. Docs should now build successfully with Sphinx 7.x.

@RoryBarnes
Fix Sphinx documentation build errors
27e72f0 
Fixed three issues preventing docs from building:

1. Theme compatibility: Removed html_theme_path pointing to outdated local theme
   - Local sphinx_rtd_theme/ is incompatible with Sphinx 7.x ('style' undefined)
   - Now uses installed sphinx_rtd_theme package from pip

2. Link reference syntax error in help.rst:18
   - Fixed: '.. BigPlanet:' → '.. _BigPlanet:' (missing underscore)
   - Removed improper indentation

3. Title underline too short in index.rst:2
   - Extended underline to match title length (7 → 26 characters)

All errors resolved. Docs should now build successfully with Sphinx 7.x.
@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.9 on ubuntu-24.04)

10 tests   9 ✅  11s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.11 on ubuntu-24.04)

10 tests   9 ✅  14s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.10 on ubuntu-24.04)

10 tests   9 ✅  14s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.11 on ubuntu-22.04)

10 tests   9 ✅  14s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.9 on ubuntu-22.04)

10 tests   9 ✅  13s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.12 on ubuntu-24.04)

10 tests   9 ✅  15s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.13 on ubuntu-24.04)

10 tests   9 ✅  15s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.10 on ubuntu-22.04)

10 tests   9 ✅  14s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.13 on ubuntu-22.04)

10 tests   9 ✅  15s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.12 on ubuntu-22.04)

10 tests   9 ✅  16s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@codecov
Copy link

codecov bot commented Jan 3, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 30.59%. Comparing base (d265b6f) to head (27e72f0).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #23   +/-   ##
=======================================
  Coverage   30.59%   30.59%           
=======================================
  Files           4        4           
  Lines         268      268           
=======================================
  Hits           82       82           
  Misses        186      186
Flag Coverage Δ
ubuntu-22.04-py3.9 30.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.14 on macos-26)

10 tests   9 ✅  16s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.14 on ubuntu-24.04)

10 tests   9 ✅  17s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.14 on ubuntu-22.04)

10 tests   9 ✅  19s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.11 on macos-15-intel)

10 tests   9 ✅  29s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.12 on macos-15-intel)

10 tests   9 ✅  34s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.9 on macos-15-intel)

10 tests   9 ✅  40s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.10 on macos-15-intel)

10 tests   9 ✅  40s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.13 on macos-15-intel)

10 tests   9 ✅  31s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.13 on macos-26)

10 tests   9 ✅  14s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.12 on macos-26)

10 tests   9 ✅  18s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.10 on macos-26)

10 tests   9 ✅  15s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.14 on macos-15-intel)

10 tests   9 ✅  31s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.11 on macos-26)

10 tests   9 ✅  17s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

Test Results (py3.9 on macos-26)

10 tests   9 ✅  19s ⏱️
 1 suites  1 💤
 1 files    0 ❌

Results for commit 27e72f0.

@RoryBarnes RoryBarnes merged commit f5db003 into main Jan 3, 2026
50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@RoryBarnes