Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Instructions to build the doc and option to build the docs without executing the notebooks. #759

Merged
merged 1 commit into from
Feb 2, 2024
Merged

Instructions to build the doc and option to build the docs without executing the notebooks. #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/Makefile
View file
Open in desktop
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
View file
Open in desktop
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
Loading