Local Build

To build and preview the documentation locally, you'll need to install Material for MKDocs along with the required plugins:

pip install \
  mkdocs-material \
  mkdocs-minify-plugin \
  mkdocs-include-markdown-plugin \
  mkdocs-exclude-search \
  mkdocs-macros-plugin \
  mkdocs-redirects \
  requests

Once everything is installed, navigate to the root of your docs repository clone and run

mkdocs serve

Strict mode

MKDocs configuration has strict parameter set to true. This will cause MkDocs to abort the build on any warnings. If you need to temporarily bypass this, run mkdocs serve --no-strict

You should see output like

INFO    -  [10:46:26] Serving on http://127.0.0.1:8000/

Open that URL in your browser to view the documentation.

API rate limit exceeded

If you see <version> instead of actual SDK version numbers, the GitHub API may have rejected request due to rate limiting.

To fix this, generate a GitHub Personal Access Token and authorize your requests:

  1. Go to https://github.com/settings/tokens.
  2. Click "Generate new token (classic)".
  3. Fill in the following:
  4. Note: Docs GitHub API Access
  5. Scopes:
    • ✅ public_repo if you're accessing only public repositories, or
    • ✅ repo if you're accessing private ones
  6. Copy the generated token ghp_... — it will be shown only once.

Then, in your terminal:

export GITHUB_TOKEN=ghp_your_token_here
mkdocs serve

This will authorize your GitHub API requests and avoid the default 60-requests-per-hour limit.