Skip to content

docs: deprioritise numba in installation pages #482

@Jammy2211

Description

@Jammy2211

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

  1. 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.
  2. PyAutoLens/docs/installation/conda.rst — Same: move Numba (lines 72-89) to after Workspace (lines 91-111); drop the warning example.
  3. PyAutoGalaxy/docs/installation/pip.rst — Mirror change: move Numba (lines 45-62) below Workspace (lines 64-84); drop warning example.
  4. PyAutoGalaxy/docs/installation/conda.rst — Mirror change: move Numba (lines 59-76) below Workspace (lines 79-99); drop warning example.
  5. PyAutoGalaxy/docs/installation/overview.rst — Delete the Known Issues section (lines 23-28) entirely.
  6. 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 & GPUInstallWorkspaceNumbaOptional → (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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions