This directory contains the Sphinx-based API reference documentation for the Arize Python SDK. This reference provides comprehensive details for the SDK's public API.

docs/
 ┣ source/
 ┃ ┣ _static/
 ┃ ┃ └── custom.css
 ┃ ┣ client.md              # ArizeClient
 ┃ ┣ config.md              # SDKConfiguration
 ┃ ┣ api_keys.md            # ApiKeysClient
 ┃ ┣ datasets.md            # DatasetsClient
 ┃ ┣ experiments.md         # ExperimentsClient, Evaluator, EvaluationResult
 ┃ ┣ ml.md                  # MLModelsClient
 ┃ ┣ projects.md            # ProjectsClient
 ┃ ┣ prompts.md             # PromptsClient
 ┃ ┣ spans.md               # SpansClient
 ┃ ┣ annotation_configs.md  # AnnotationConfigsClient, AnnotationConfigType
 ┃ ┣ spaces.md              # SpacesClient
 ┃ ┣ embeddings.md          # EmbeddingGenerator
 ┃ ┣ conf.py                # Sphinx configuration
 ┃ └── index.md             # Main entry point
 ┣ Makefile
 ┣ make.bat
 ┣ requirements.txt
 └── README.md

• conf.py: Sphinx configuration for theme, extensions, and autodoc settings
• index.md: Main entry point with table of contents
• requirements.txt: Python dependencies for building the documentation
• Makefiles: Commands for building HTML documentation locally

Install dependencies:

pip install -e '.[docs,otel,mimic,embeddings]'

cd docs
make clean
make html

The generated HTML will be in build/html/. Open build/html/index.html in your browser.

For development with auto-reload:

make livehtml

The documentation uses the PyData Sphinx Theme, which provides:

• Clean, modern design
• Responsive layout
• Good navigation

Documentation is automatically generated from Google-style docstrings in the source code using Sphinx's autodoc extension.

Configuration settings:

• autodoc_typehints = "none" - Types documented in parameter descriptions
• autoclass_content = "class" - Only class docstring, not init
• add_module_names = False - Cleaner class names

Markdown files are processed using MyST Parser, allowing:

• Markdown syntax for documentation
• Sphinx directives with {eval-rst} blocks
• Cross-references and linking

1. Create a new .md file in source/ directory

2. Add autodoc directives:

   # MyClass
   
   ```{eval-rst}
   .. currentmodule:: arize.mymodule
   
   .. autoclass:: MyClass
      :members:
      :undoc-members:
      :show-inheritance:
      :special-members: __init__
   ```

3. Add the file to the toctree in index.md:

   ```{toctree}
   :maxdepth: 2
   
   client
   myclass  # <- Add here
   ```

4. Rebuild the documentation

For ReadTheDocs integration, create a .readthedocs.yaml file in the repository root (see plan document for template).