Contribute to documentation

The MaxText documentation website is built using Sphinx and MyST. Documents are written in MyST Markdown syntax.

Building the documentation locally (optional)

If you are writing documentation for MaxText, you may want to preview the documentation site locally to ensure things work as expected before a deployment to Read The Docs.

First, make sure you install MaxText from source and install the necessary dependencies. You can do this by navigating to your local clone of the MaxText repo and running:

uv pip install -r src/dependencies/requirements/requirements_docs.txt

Once the dependencies are installed and your maxtext_venv virtual environment is activated, you can navigate to the docs/ folder and run:

sphinx-build -b html . _build/html

This will generate the documentation in the docs/_build/html directory. These files can be opened in a web browser directly, or you can use a simple HTTP server to serve the files. For example, you can run:

python -m http.server -d _build/html

Then, open your web browser and navigate to http://localhost:8000 to view the documentation.

Adding new documentation files

If you are adding a new document, make sure it is included in the toctree directive corresponding to the section where the new document should live. For example, if adding a new tutorial, make sure it is listed in the docs/tutorials.md toctree.

Documentation deployment

The latest version of the MaxText documentation, tracking the main branch of development, is automatically deployed to https://maxtext.readthedocs.io/en/latest on any successful merge to the main branch.