diff --git a/README.md b/README.md index 3c1c473a8..04eca2929 100644 --- a/README.md +++ b/README.md @@ -148,16 +148,19 @@ Please let us know on [the issue tracker](https://github.com/google/jax/issues) if you run into any errors or problems with the prebuilt wheels. ### Building JAX from source +See [Building JAX from source](https://jax.readthedocs.io/en/latest/developer.html#building-from-source). -The Colab notebooks are tested for errors as part of the documentation build. -See [docs/README.md](docs/README.md) for instructions. - ## Reference documentation For details about the JAX API, see the [reference documentation](https://jax.readthedocs.io/). +## Developer documentation + +For getting started as a JAX developer, see the +[developer documentation](https://jax.readthedocs.io/en/latest/developer.html). + ## A brief tour ```python diff --git a/docs/README.md b/docs/README.md index 86e3ce1a9..12e004255 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,2 @@ -To rebuild the documentation, install the following Python packages: -``` -pip install sphinx sphinx_rtd_theme nbsphinx fastcache ipykernel -``` - -Install also `pandoc`: -``` -sudo apt-get install pandoc -``` - -and then run: - -``` -sphinx-build -M html . build -``` +To rebuild the documentation, +see [Update Documentation](https://jax.readthedocs.io/en/latest/developer.html#update-documentation). diff --git a/docs/developer.rst b/docs/developer.rst index d8bae701a..00667f0ea 100644 --- a/docs/developer.rst +++ b/docs/developer.rst @@ -89,6 +89,7 @@ file directly to see more detailed information about the cases being run: python tests/lax_numpy_test.py --num_generated_cases=5 +The Colab notebooks are tested for errors as part of the documentation build. Update documentation ====================