2023-12-01 03:12:53 +08:00
|
|
|
# Copyright © 2023 Apple Inc.
|
|
|
|
|
|
2023-11-30 02:30:41 +08:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
|
|
|
|
|
import os
|
|
|
|
|
import subprocess
|
|
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
|
|
|
|
project = "MLX"
|
|
|
|
|
copyright = "2023, MLX Contributors"
|
|
|
|
|
author = "MLX Contributors"
|
2024-01-12 05:56:03 +08:00
|
|
|
version = "0.0.9"
|
|
|
|
|
release = "0.0.9"
|
2023-11-30 02:30:41 +08:00
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
|
|
|
|
extensions = [
|
|
|
|
|
"sphinx.ext.autodoc",
|
|
|
|
|
"sphinx.ext.autosummary",
|
|
|
|
|
"sphinx.ext.intersphinx",
|
|
|
|
|
"sphinx.ext.napoleon",
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
python_use_unqualified_type_names = True
|
|
|
|
|
autosummary_generate = True
|
|
|
|
|
|
|
|
|
|
intersphinx_mapping = {
|
|
|
|
|
"https://docs.python.org/3": None,
|
|
|
|
|
"https://numpy.org/doc/stable/": None,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
templates_path = ["_templates"]
|
|
|
|
|
html_static_path = ["_static"]
|
|
|
|
|
source_suffix = ".rst"
|
|
|
|
|
master_doc = "index"
|
|
|
|
|
highlight_language = "python"
|
|
|
|
|
pygments_style = "sphinx"
|
|
|
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
|
|
2023-12-06 04:08:05 +08:00
|
|
|
html_theme = "sphinx_book_theme"
|
|
|
|
|
|
|
|
|
|
html_theme_options = {
|
|
|
|
|
"show_toc_level": 2,
|
|
|
|
|
"repository_url": "https://github.com/ml-explore/mlx",
|
|
|
|
|
"use_repository_button": True,
|
|
|
|
|
"navigation_with_keys": False,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
html_logo = "_static/mlx_logo.png"
|
|
|
|
|
|
2023-11-30 02:30:41 +08:00
|
|
|
|
|
|
|
|
# -- Options for HTMLHelp output ---------------------------------------------
|
|
|
|
|
|
|
|
|
|
htmlhelp_basename = "mlx_doc"
|
