mirror of
https://github.com/ROCm/jax.git
synced 2025-04-14 10:56:06 +00:00
Fixes to the documentation
* Included "Building from source" in README.md * Added references from docs/README.md to docs/developer.rst
This commit is contained in:
parent
e42c010605
commit
a9d9504348
@ -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
|
||||
|
@ -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).
|
||||
|
@ -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
|
||||
====================
|
||||
|
Loading…
x
Reference in New Issue
Block a user