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:
George Necula 2019-10-09 17:45:09 +02:00
parent e42c010605
commit a9d9504348
3 changed files with 9 additions and 18 deletions

View File

@ -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

View File

@ -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).

View File

@ -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
====================