JaxGaussianProcesses / GPJax

Gaussian processes in JAX.
https://docs.jaxgaussianprocesses.com/
Apache License 2.0
436 stars 51 forks source link

Update docs build process #461

Closed frazane closed 4 weeks ago

frazane commented 1 month ago

Type of changes

Description

This PR brings changes to the doc build process, specifically to how the example notebooks are handled. In short, we stop using some mkdocs plugins and instead use jupytext and nbcovert directly, which is more robust and only adds an extra command to the building process. Here's a summary of the changes:

With these changes, the documentation can now be generated with:

poetry run python docs/scripts/gen_examples.py && poetry run mkdocs serve
Thomas-Christie commented 1 month ago

FYI I realised Ruff has been pinned to an old version for a while - I upgraded it and fixed the raised issues (some of which are present in this PR) in https://github.com/JaxGaussianProcesses/GPJax/pull/461

thomaspinder commented 1 month ago

FYI I realised Ruff has been pinned to an old version for a while - I upgraded it and fixed the raised issues (some of which are present in this PR) in #461

Thanks @Thomas-Christie. I merged that PR, so you can probably just rebase from that @frazane