numba / llvmlite

A lightweight LLVM python binding for writing JIT compilers
https://llvmlite.pydata.org/
BSD 2-Clause "Simplified" License
1.94k stars 321 forks source link

Use RTD for all docs CI / testing (was: Try and get CI to use a newer Sphinx) #1053

Closed gmarkall closed 5 months ago

gmarkall commented 6 months ago

~Some PRs (e.g. #1046) have problems with the docs because of the old Sphinx version CI is using, the latest available in the defaults channel being 5.0.2. This PR switches to using conda-forge to get later versions, so that features such as :no-index: can be used.~

~From the CI logs:~

    sphinx-7.3.7               |     pyhd8ed1ab_0         1.3 MB  conda-forge
    sphinx_rtd_theme-2.0.0     |     pyha770c72_0         2.5 MB  conda-forge

Update: The new approach in this PR is to remove the docs testing on Azure and enable nitpicky mode in the Sphinx config. Now:

I purposely broke a reference in adf79ff, and then the RTD build failed with nitpicky mode was enabled, demonstrating that this is testing for broken references. I have subsequently reverted / fixed the broken reference in a later commit, and removed the Azure docs testing.

gmarkall commented 5 months ago

Notes from triage meeting - we should make sure RTD is building with warnings as errors and then remove the py39_docs build.

esc commented 5 months ago

@gmarkall thank you for the patch!