Jake VanderPlas
7965c907a9
[typing] improve sphinx rendering of type aliases
2023-01-04 09:10:48 -08:00
Jake VanderPlas
406b5525a4
DOC: fix sphinx version for readthedocs
2022-12-29 15:37:54 -08:00
Matthew Johnson
1185c895ca
in jax.Array notebook, polish beginning and tweak title and some wording
2022-12-10 22:16:54 -08:00
Jake VanderPlas
7b59ce2f89
DOC: pre-execute the quickstart notebook on GPU
2022-12-06 13:24:02 -08:00
Skye Wanderman-Milne
51db1cfd0e
[docs] Rename "JAX in Parallelism" files so the URL matches the title.
2022-12-01 19:53:31 +00:00
yashkatariya
aca7e4ade2
jax.Array tutorial
2022-11-15 16:49:17 -08:00
Peter Hawkins
ba557d5e1b
Change JAX's copyright attribution from "Google LLC" to "The JAX Authors.".
...
See https://opensource.google/documentation/reference/releasing/contributions#copyright for more details.
PiperOrigin-RevId: 476167538
2022-09-22 12:27:19 -07:00
Filippo Vicentini
52236adeed
Show link to GitHub repo in navbar
2022-09-05 13:41:49 +02:00
Peter Hawkins
71b29b1cc6
Create JAX Enhancement Proposals (JEPs).
...
Migrate existing design documents to JEPs.
2022-08-08 16:13:58 -04:00
Jake VanderPlas
d8d836bfb0
Fix execution issues in type_promotion doc
2022-07-11 14:16:11 -07:00
Ahti Kitsik
2764da5c71
DOC: fix docs generator to group notebook code output
2022-05-21 09:36:38 +02:00
Jake VanderPlas
c2f4a1a409
DOC: fix scipy intersphinx link
2022-05-20 15:17:26 -07:00
Jake VanderPlas
681240244c
DOC: explicitly enable dollarmath extension
2022-05-12 10:37:34 -07:00
Jake VanderPlas
29efc30c63
DOC: update myst-nb to v0.15.0
2022-05-09 14:32:48 -07:00
tornikeo
6423741db0
Add copy button to code snippets in documentation
2022-02-22 13:49:48 +04:00
Jake VanderPlas
7381bbe8bb
Add type promotion design doc
2022-02-14 14:16:42 -08:00
Peter Hawkins
465b593293
Update scipy intersphinx inventory for SciPy 1.8.0.
...
According to https://github.com/scipy/scipy/issues/14267 the SciPy docs seems to have moved.
2022-02-07 16:19:46 -05:00
Peter Hawkins
efacc93088
Use the sphinx-book-theme for JAX documentation.
2022-02-04 09:00:07 -05:00
Roy Frostig
e659c54977
docs: remove application tutorials
2021-09-10 18:52:47 -07:00
TinaZetongJia
e7e8183a40
not exclude 08-pjit.md
2021-09-09 15:24:04 -07:00
George Necula
117d0d23ab
Attempt to fix RTD build
...
It seems that the failure is for transformations.md
2021-07-18 19:35:14 +03:00
Peter Hawkins
b746d021c8
Disable xmap_tutorial to fix doc CI build.
2021-06-25 19:55:23 -04:00
George Necula
6a48c60a72
Rename master to main in embedded links.
...
Tried to avoid the change on external links to repos that
have not yet renamed master.
2021-06-18 10:00:01 +03:00
Jake VanderPlas
d9df65986a
Initial commit of second JAX-101 notebook
2021-03-03 09:43:16 -08:00
Jake VanderPlas
5396f04c65
DOC: add first JAX-101 notebook
2021-02-26 09:22:34 -08:00
Tom Hennigan
090dd2117d
Add autodidax to dev docs toctree and ignore md file to silence warning.
...
Fixes CI failure from google/jax#5827 .
2021-02-25 10:50:10 +00:00
Jake VanderPlas
b14a9d9c1d
readthedocs: set fail_on_warning=true
2021-02-23 13:21:06 -08:00
Jake VanderPlas
067be89a0c
DOC: minor documentation & formatting fixes
2021-02-23 10:31:44 -08:00
jax authors
2bf97298be
Merge pull request #5765 from jakevdp:cleanup-notebooks
...
PiperOrigin-RevId: 358847147
2021-02-22 10:21:42 -08:00
Jake VanderPlas
c9fd50ccf3
DOC: execute XLA_in_Python notebook
2021-02-22 10:04:42 -08:00
Jake VanderPlas
4b21f3ef7a
Add :jax-issue: sphinx role for use in CHANGELOG.
2021-02-22 09:34:24 -08:00
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