Skip to content

Commit 9f370d5

Browse files
committed
Fix doc build warnings (toctree extension) and 429 rate limit errors
1 parent 36d7beb commit 9f370d5

3 files changed

Lines changed: 6 additions & 3 deletions

File tree

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,9 @@
165165
r"https://github\.com/jax-ml/jax/commits/.*",
166166
# Ignore Hugging Face settings links which require login
167167
r"https://huggingface\.co/settings/tokens",
168+
# Ignore GitHub PRs and blobs that trigger rate limiting
169+
r"https://github\.com/AI-Hypercomputer/maxtext/pull/.*",
170+
r"https://github\.com/google/maxtext/blob/.*",
168171
]
169172

170173

docs/development/contribute_docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ in [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/syntax/ty
2424

2525
If you are writing documentation for MaxText, you may want to preview the
2626
documentation site locally to ensure things work as expected before a deployment
27-
to [Read The Docs](https://readthedocs.org/).
27+
to [Read The Docs](https://about.readthedocs.com/?ref=app.readthedocs.org).
2828

2929
First, make sure you
3030
[install MaxText from source](https://maxtext.readthedocs.io/en/latest/install_maxtext.html#from-source)

docs/reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Key concepts including checkpointing strategies, quantization, tiling, and Mixtu
5353

5454
## 📚 API Reference
5555

56-
Find comprehensive API documentation for MaxText modules, classes, and functions in the [API Reference page](reference/api.rst).
56+
Find comprehensive API documentation for MaxText modules, classes, and functions in the [API Reference page](reference/api).
5757

5858
```{toctree}
5959
---
@@ -64,5 +64,5 @@ reference/performance_metrics
6464
reference/models
6565
reference/architecture
6666
reference/core_concepts
67-
reference/api.rst
67+
reference/api
6868
```

0 commit comments

Comments
 (0)