From 0a2601f31ec1854cde73837b8d102d7a3257e74d Mon Sep 17 00:00:00 2001 From: Vincent Roulet Date: Fri, 2 Feb 2024 13:13:21 -0800 Subject: [PATCH] Instructions to build the doc and option to build the docs without executing the notebooks. PiperOrigin-RevId: 603769230 --- docs/Makefile | 5 +++++ docs/contributors.md | 8 ++++++++ 2 files changed, 13 insertions(+) diff --git a/docs/Makefile b/docs/Makefile index 21064e56..f527284c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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." diff --git a/docs/contributors.md b/docs/contributors.md index d1b4e160..768ec359 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -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)