Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,12 @@ instance/
# Scrapy stuff:
.scrapy

# Generated API docs
api-docs/

# Sphinx documentation
**/docs/_build/
docs/sphinx/_autogen/
**/docs/source/_reference
**/docs/source/_api_doc

Expand Down
18 changes: 18 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
.PHONY: install docs lint license-check test test-integration test-pkg test-pkg-integration

install:
uv sync --all-packages --all-extras

docs:
uv run sphinx-apidoc -e -M -f -T \
-o docs/sphinx/_autogen \
packages/base/ai_api_client_sdk \
packages/base/ai_api_client_sdk/helpers
uv run sphinx-apidoc -e -M -f -T \
-o docs/sphinx/_autogen \
packages/core/ai_core_sdk \
packages/core/ai_core_sdk/helpers \
packages/core/ai_core_sdk/cli.py
uv run sphinx-apidoc -e -M -f -T \
-o docs/sphinx/_autogen \
packages/gen/gen_ai_hub \
packages/gen/gen_ai_hub/evaluations/_internal
uv run sphinx-build -b html docs/sphinx api-docs/

lint:
uv run pylint ai_api_client_sdk ai_core_sdk gen_ai_hub --errors-only --output-format=colorized

Expand Down
15 changes: 15 additions & 0 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
project = "SAP AI SDK Python"
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
]
html_theme = "furo"
exclude_patterns = ["_autogen/modules.rst"]
autodoc_default_options = {
"members": True,
"undoc-members": True,
"private-members": False,
"show-inheritance": True,
"special-members": "__init__",
}
autodoc_member_order = "bysource"
17 changes: 17 additions & 0 deletions docs/sphinx/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
SAP AI SDK Python
=================

.. toctree::
:maxdepth: 1
:caption: Packages

_autogen/ai_api_client_sdk
_autogen/ai_core_sdk
_autogen/gen_ai_hub

Indices
-------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ requires-python = ">=3.10"
license = "Apache-2.0"

[dependency-groups]
dev = ["pip-licenses>=5.5.5", "commitizen>=4"]
dev = ["pip-licenses>=5.5.5", "commitizen>=4", "sphinx>=7.0.0", "furo"]

[tool.uv.sources]
sap-ai-sdk-base = { workspace = true }
Expand Down
47 changes: 47 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.