Skip to content

Commit

Permalink
Instructions to build the doc and option to build the docs without ex…
Browse files Browse the repository at this point in the history
…ecuting the notebooks.

PiperOrigin-RevId: 603697632
  • Loading branch information
vroulet authored and OptaxDev committed Feb 2, 2024
1 parent b112c1e commit 497615f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ help:

clean:
rm -rf $(BUILDDIR)/* auto_examples _collections modules

html-noplot:
$(SPHINXBUILD) -D plot_gallery=0 -D jupyter_execute_notebooks=off -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
8 changes: 8 additions & 0 deletions docs/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ contributors are given in the
[issue tracker](https://github.com/deepmind/optax/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue).
Ideas for good starter contributions are also welcomed.

#### Improving the documentation

If you would like to help contributing to the documentation, install the
required packages by running `pip install .[docs]`.
Then, to build the docs, from the docs folder, run `make html` to build all docs
and notebooks or `make html-noplot` to build the docs without executing
the notebooks (much faster).

## Core Maintainers

* [Iurii Kemaev](https://github.com/hbq1)
Expand Down

0 comments on commit 497615f

Please sign in to comment.