30 Commits

Author SHA1 Message Date
Jake VanderPlas
e56c1d9d0c DOC: suppress some warnings 2021-02-16 17:18:38 -08:00
Jake VanderPlas
d85d204897 DOC: change build from nbsphinx to myst 2021-02-16 10:28:39 -08:00
Jake VanderPlas
6eedadc27f DOC: use jupytext to maintain synced markdown versions of notebooks. 2021-02-10 12:23:07 -08:00
Jake VanderPlas
cfe934c053 Fix some doc build warnings 2021-01-25 14:08:57 -08:00
Jake VanderPlas
ef092691fb Cleanup: fix some sphinx warnings 2021-01-15 14:21:13 -08:00
Jake VanderPlas
76dc2c1e8f DOC: update webpage copyright year to 2020 2020-11-10 11:54:36 -08:00
Jamie Townsend
62683959b1 [DOCS] Add JAX favicon to sphinx 2020-11-06 13:43:18 +00:00
Matthew Johnson
6b6789a53b
applied simple find+sed for 'master' -> 'main' (#4174)
* applied simple find+sed for 'master' -> 'main'

* Rename master->main in JAX API and internals (#4178)

* Started with #4174 
* Renamed Trace.master to Trace.main
* Renamed core.new_master and core.new_base_master

Co-authored-by: George Necula <gcnecula@gmail.com>
2020-08-30 11:16:51 +03:00
George Necula
57d5a39018
Disable the workaround to prevent expansion of type aliases (#3485)
* Disable the workaround to prevent expansion of type aliases

* Fix flake
2020-06-18 21:01:40 +03:00
Skye Wanderman-Milne
8bc7820573
Use myst to parse markdown docs, and convert a page from rst to markdown. (#3477)
Also sets the minimum sphinx version to 2.1.
2020-06-17 16:59:14 -07:00
Peter Hawkins
6b948e6482
Generate type hints for parameters, even if the parameters aren't documented. (#3337)
This change tells sphinx-autodoc-typehint to generate stub parameter documentation for arguments that have type hints.
2020-06-08 08:56:10 -04:00
Peter Hawkins
1a3c18058e
Don't expand type aliases when generating JAX documentation. (#3336) 2020-06-05 17:21:18 -04:00
George Necula
3ca7f6e4f1
Fixes in the FAQ for RST (#2761) 2020-04-19 11:13:07 +02:00
Matthew Johnson
909fee6a2d try adding sphinx-autodoc-typehints 2020-03-30 20:22:04 -07:00
George Necula
42bf313fa1 Fixed the name of the excluded notebook
Issue: #2236
2020-02-15 12:10:30 +01:00
George Necula
1c6cd25417 Temporarily disable XLA_in_Python notebook, pending fixing of bug
Issue: #2236
2020-02-15 12:03:40 +01:00
George Necula
370558def3 Removed a couple of slow notebooks from RTD auto-rendering.
Trying to address the timeouts in RTD rendering.

Also fixed bad itemized list in autodiff cookbook, and a few minor warnings:
Issue: #2092
2020-02-15 11:43:10 +01:00
Colin
d6489103f7
Bump cell execution timeout (#2147)
Looking at the recent [doc failures](https://readthedocs.org/projects/jax/builds/), a few are due to 

- Cell timeouts (which this tries to fix),
- Execution timeout (readthedocs gives 900seconds to build, total -- most of the time for jax is in executing the notebooks),
- Other somewhat random/inscrutable errors (and I could imagine a world in which one of the timeouts ends up triggering an inscrutable error in the execution).
2020-02-03 10:15:19 -05:00
Yo
322ebe7c9b Update docs/conf.py 2019-12-30 11:27:12 -08:00
flowed
e0693fe649 Fix Typos 2019-12-30 11:27:12 -08:00
George Necula
0ffcd769ef
Add sklearn to Travis, for documentation building. (#1547)
* Add sklearn to Travis, for documentation building.
* Add score_matching to auto-built notebooks
2019-10-21 23:24:16 +02:00
George Necula
eae59d0b2c
Moved all notebooks to docs/notebooks. (#1493)
* Moved all notebooks to docs/notebooks.

Now all notebooks are in the same place, thus all are subject
to auto-doc generation at readthedocs.io and to automated testing
with travis.

Some notebooks are too slow, exclude them at docs/conf.py:exclude_patterns.

Cleanup a bit the section headings in notebooks so that they show
up well in readtehdocs.io.

* Increase the cell timeout for executing notebooks
* Exclude also the neural network notebook from auto-generation (timing out)
* Disable the score_matching notebook from auto-doc (travis does not have sklearn)
2019-10-17 08:58:25 +02:00
George Necula
e42c010605 Create developer documentation.
* Moved out of README.md some developer-only stuff to docs/developer.rst.
    * Added documentation about building the documentation
2019-10-09 17:24:01 +02:00
George Necula
41457633cc Increase readthedocs/nbsphinx timeout
It seems tht RTD is timing out when compiling the How_JAX_primitives_work noteboook.
2019-10-07 18:07:55 +02:00
George Necula
0fdf377343 Switched testing to using sphinx (part of the documentation generation) 2019-10-03 20:54:28 +02:00
Stephan Hoyer
08254fe5bc Fixup colab notebook URLs 2019-09-30 11:12:01 -07:00
Stephan Hoyer
9bd7330e1f
Notebooks on RTD (#1121) 2019-09-30 11:00:02 -07:00
Stephan Hoyer
8c8222a319 Add the JAX logo to sphinx docs 2019-08-05 12:34:29 -07:00
Peter Hawkins
326c3dbb99 Add license header to docs/conf.py. 2019-01-24 08:39:50 -05:00
Peter Hawkins
86d8915c3d Add Sphinx-generated reference documentation for JAX. 2019-01-16 09:13:31 -05:00