Overview
Numba was historically a critical dependency for PyAutoLens / PyAutoGalaxy and the install docs were structured around it — a dedicated "Numba" section sits between Install and Workspace in every install guide, the PyAutoGalaxy overview opens with a "Known Issues" callout warning about llvmlite/numba, and the standalone numba.rst page has long troubleshooting sections for old conda/numpy version conflicts. Numba is no longer that important. This task retains numba as a documented optional install but pushes it down each page so it stops being the first thing a new user trips over, and removes stale install-issue warnings (most of which reference Python 3.8 / NumPy 1.21, which are no longer supported anyway).
Plan
- Move the dedicated
Numba section to sit after Workspace in pip + conda install pages (PyAutoLens + PyAutoGalaxy).
- Remove the
numba 0.53.1 ... llvmlite warning example from the install pages.
- Remove the prominent
Known Issues callout about numba/llvmlite from PyAutoGalaxy's installation overview.
- Remove the stale
Troubleshooting (Conda) and Troubleshooting (Numpy) sections from PyAutoGalaxy's standalone numba.rst page; keep the core "what numba is and how to install it" content.
- Leave
source.rst (build-from-source instructions) and troubleshooting.rst untouched.
Detailed implementation plan
Affected Repositories
- PyAutoLabs/PyAutoLens (primary)
- PyAutoLabs/PyAutoGalaxy (parallel docs change)
Work Classification
Library (docs-only; no API change, no workspace impact, no tests to update)
Branch Survey
| Repository |
Current Branch |
Dirty? |
| ./PyAutoLens |
main |
clean |
| ./PyAutoGalaxy |
main |
clean |
Suggested branch: feature/numba-docs-deprioritize
Worktree root: ~/Code/PyAutoLabs-wt/numba-docs-deprioritize/ (created later by /start_library)
Implementation Steps
- PyAutoLens/docs/installation/pip.rst — Move the
Numba heading + body (lines 59-76) to sit after Workspace (lines 78-98) and before Optional. Drop the numba 0.53.1 / llvmlite warning example block from the Install section.
- PyAutoLens/docs/installation/conda.rst — Same: move
Numba (lines 72-89) to after Workspace (lines 91-111); drop the warning example.
- PyAutoGalaxy/docs/installation/pip.rst — Mirror change: move
Numba (lines 45-62) below Workspace (lines 64-84); drop warning example.
- PyAutoGalaxy/docs/installation/conda.rst — Mirror change: move
Numba (lines 59-76) below Workspace (lines 79-99); drop warning example.
- PyAutoGalaxy/docs/installation/overview.rst — Delete the
Known Issues section (lines 23-28) entirely.
- PyAutoGalaxy/docs/installation/numba.rst — Keep top-of-page intro +
pip install numba. Delete Troubleshooting (Conda) and Troubleshooting (Numpy) subsections (lines 26-83).
Files NOT Modified
source.rst in either repo — numba install steps stay; user said "retain it in the installation instructions".
troubleshooting.rst in either repo — neither mentions numba (verified).
index.rst in either repo — only references installation/numba in toctree; fine.
- PyAutoFit docs — no numba references in installation docs.
Verification
Build docs locally with sphinx-build -b html docs docs/_build/html for each repo and confirm:
- Section order on each install page is:
JAX & GPU → Install → Workspace → Numba → Optional → (Legacy Python versions for pip).
- PyAutoGalaxy
installation/overview.html no longer has a Known Issues section.
- PyAutoGalaxy
installation/numba.html no longer has the two Troubleshooting (...) subsections.
grep -r "Known Issues" docs/ and grep -r "Troubleshooting (Conda)\|Troubleshooting (Numpy)" docs/ return nothing in PyAutoGalaxy.
Original Prompt
Click to expand starting prompt
No longer make numba so high up on docs as not as important as it used to be.
So, retain it in the installation instructions, but move it below Workspace.
Overview
Numba was historically a critical dependency for PyAutoLens / PyAutoGalaxy and the install docs were structured around it — a dedicated "Numba" section sits between Install and Workspace in every install guide, the PyAutoGalaxy overview opens with a "Known Issues" callout warning about
llvmlite/numba, and the standalonenumba.rstpage has long troubleshooting sections for old conda/numpy version conflicts. Numba is no longer that important. This task retains numba as a documented optional install but pushes it down each page so it stops being the first thing a new user trips over, and removes stale install-issue warnings (most of which reference Python 3.8 / NumPy 1.21, which are no longer supported anyway).Plan
Numbasection to sit afterWorkspacein pip + conda install pages (PyAutoLens + PyAutoGalaxy).numba 0.53.1 ... llvmlitewarning example from the install pages.Known Issuescallout aboutnumba/llvmlitefrom PyAutoGalaxy's installation overview.Troubleshooting (Conda)andTroubleshooting (Numpy)sections from PyAutoGalaxy's standalonenumba.rstpage; keep the core "what numba is and how to install it" content.source.rst(build-from-source instructions) andtroubleshooting.rstuntouched.Detailed implementation plan
Affected Repositories
Work Classification
Library (docs-only; no API change, no workspace impact, no tests to update)
Branch Survey
Suggested branch:
feature/numba-docs-deprioritizeWorktree root:
~/Code/PyAutoLabs-wt/numba-docs-deprioritize/(created later by/start_library)Implementation Steps
Numbaheading + body (lines 59-76) to sit afterWorkspace(lines 78-98) and beforeOptional. Drop thenumba 0.53.1/llvmlitewarning example block from theInstallsection.Numba(lines 72-89) to afterWorkspace(lines 91-111); drop the warning example.Numba(lines 45-62) belowWorkspace(lines 64-84); drop warning example.Numba(lines 59-76) belowWorkspace(lines 79-99); drop warning example.Known Issuessection (lines 23-28) entirely.pip install numba. DeleteTroubleshooting (Conda)andTroubleshooting (Numpy)subsections (lines 26-83).Files NOT Modified
source.rstin either repo — numba install steps stay; user said "retain it in the installation instructions".troubleshooting.rstin either repo — neither mentions numba (verified).index.rstin either repo — only referencesinstallation/numbain toctree; fine.Verification
Build docs locally with
sphinx-build -b html docs docs/_build/htmlfor each repo and confirm:JAX & GPU→Install→Workspace→Numba→Optional→ (Legacy Python versionsfor pip).installation/overview.htmlno longer has aKnown Issuessection.installation/numba.htmlno longer has the twoTroubleshooting (...)subsections.grep -r "Known Issues" docs/andgrep -r "Troubleshooting (Conda)\|Troubleshooting (Numpy)" docs/return nothing in PyAutoGalaxy.Original Prompt
Click to expand starting prompt
No longer make numba so high up on docs as not as important as it used to be.
So, retain it in the installation instructions, but move it below Workspace.