From 56b83bfdd7d3a0d600bb3702cde7a90cc6fbca74 Mon Sep 17 00:00:00 2001 From: Dmitrii Iutkin Date: Fri, 30 Oct 2026 10:15:16 +0200 Subject: [PATCH] Fix Sphinx docs build errors Point the service API pages at the public import paths, such as verda.containers.ContainersService. The old paths named modules that no longer exist, so autodoc could not import them. Include CHANGELOG.md and CONTRIBUTING.md with the recommonmark parser. The pages referenced .rst files that no longer exist, so they had no content and no title. Add inference_minimal_async to the container examples toctree. Co-Authored-By: Claude Opus 5.5 --- docs/source/api/services/balance.rst | 4 ++-- docs/source/api/services/containers.rst | 4 ++-- docs/source/api/services/images.rst | 4 ++-- docs/source/api/services/instance_types.rst | 4 ++-- docs/source/api/services/instances.rst | 4 ++-- docs/source/api/services/ssh_keys.rst | 4 ++-- docs/source/api/services/startup_scripts.rst | 4 ++-- docs/source/api/services/volume_types.rst | 4 ++-- docs/source/api/services/volumes.rst | 4 ++-- docs/source/changelog.rst | 3 ++- docs/source/contributing.rst | 3 ++- docs/source/examples/containers/index.rst | 3 ++- 12 files changed, 24 insertions(+), 21 deletions(-) diff --git a/docs/source/api/services/balance.rst b/docs/source/api/services/balance.rst index e310ae1..f777d22 100644 --- a/docs/source/api/services/balance.rst +++ b/docs/source/api/services/balance.rst @@ -1,8 +1,8 @@ Balance ======= -.. autoclass:: verda.balance.balance.BalanceService +.. autoclass:: verda.balance.BalanceService :members: -.. autoclass:: verda.balance.balance.Balance +.. autoclass:: verda.balance.Balance :members: \ No newline at end of file diff --git a/docs/source/api/services/containers.rst b/docs/source/api/services/containers.rst index c92fa2d..19ea502 100644 --- a/docs/source/api/services/containers.rst +++ b/docs/source/api/services/containers.rst @@ -1,9 +1,9 @@ Containers ========== -.. autoclass:: verda.containers.containers.ContainersService +.. autoclass:: verda.containers.ContainersService :members: -.. autoclass:: verda.containers.containers.Container +.. autoclass:: verda.containers.Container :members: diff --git a/docs/source/api/services/images.rst b/docs/source/api/services/images.rst index 621f17e..378b5ad 100644 --- a/docs/source/api/services/images.rst +++ b/docs/source/api/services/images.rst @@ -1,8 +1,8 @@ Images ====== -.. autoclass:: verda.images.images.ImagesService +.. autoclass:: verda.images.ImagesService :members: -.. autoclass:: verda.images.images.Image +.. autoclass:: verda.images.Image :members: \ No newline at end of file diff --git a/docs/source/api/services/instance_types.rst b/docs/source/api/services/instance_types.rst index 1ee1541..599fc1d 100644 --- a/docs/source/api/services/instance_types.rst +++ b/docs/source/api/services/instance_types.rst @@ -1,8 +1,8 @@ Instance Types ============== -.. autoclass:: verda.instance_types.instance_types.InstanceTypesService +.. autoclass:: verda.instance_types.InstanceTypesService :members: -.. autoclass:: verda.instance_types.instance_types.InstanceType +.. autoclass:: verda.instance_types.InstanceType :members: \ No newline at end of file diff --git a/docs/source/api/services/instances.rst b/docs/source/api/services/instances.rst index b4c1409..08656a0 100644 --- a/docs/source/api/services/instances.rst +++ b/docs/source/api/services/instances.rst @@ -1,8 +1,8 @@ Instances ========= -.. autoclass:: verda.instances.instances.InstancesService +.. autoclass:: verda.instances.InstancesService :members: -.. autoclass:: verda.instances.instances.Instance +.. autoclass:: verda.instances.Instance :members: \ No newline at end of file diff --git a/docs/source/api/services/ssh_keys.rst b/docs/source/api/services/ssh_keys.rst index ae9da7f..16432a6 100644 --- a/docs/source/api/services/ssh_keys.rst +++ b/docs/source/api/services/ssh_keys.rst @@ -1,8 +1,8 @@ SSH Keys ======== -.. autoclass:: verda.ssh_keys.ssh_keys.SSHKeysService +.. autoclass:: verda.ssh_keys.SSHKeysService :members: -.. autoclass:: verda.ssh_keys.ssh_keys.SSHKey +.. autoclass:: verda.ssh_keys.SSHKey :members: \ No newline at end of file diff --git a/docs/source/api/services/startup_scripts.rst b/docs/source/api/services/startup_scripts.rst index d9b89ed..171f18d 100644 --- a/docs/source/api/services/startup_scripts.rst +++ b/docs/source/api/services/startup_scripts.rst @@ -1,8 +1,8 @@ Startup Scripts =============== -.. autoclass:: verda.startup_scripts.startup_scripts.StartupScriptsService +.. autoclass:: verda.startup_scripts.StartupScriptsService :members: -.. autoclass:: verda.startup_scripts.startup_scripts.StartupScript +.. autoclass:: verda.startup_scripts.StartupScript :members: \ No newline at end of file diff --git a/docs/source/api/services/volume_types.rst b/docs/source/api/services/volume_types.rst index cdf70cc..9a1b998 100644 --- a/docs/source/api/services/volume_types.rst +++ b/docs/source/api/services/volume_types.rst @@ -1,8 +1,8 @@ Volume Types ============ -.. autoclass:: verda.volume_types.volume_types.VolumeTypesService +.. autoclass:: verda.volume_types.VolumeTypesService :members: -.. autoclass:: verda.volume_types.volume_types.VolumeType +.. autoclass:: verda.volume_types.VolumeType :members: \ No newline at end of file diff --git a/docs/source/api/services/volumes.rst b/docs/source/api/services/volumes.rst index b6c850a..ac06bd6 100644 --- a/docs/source/api/services/volumes.rst +++ b/docs/source/api/services/volumes.rst @@ -1,8 +1,8 @@ Volumes ======= -.. autoclass:: verda.volumes.volumes.VolumesService +.. autoclass:: verda.volumes.VolumesService :members: -.. autoclass:: verda.volumes.volumes.Volume +.. autoclass:: verda.volumes.Volume :members: \ No newline at end of file diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 6f90edd..b89da39 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -1 +1,2 @@ -.. include:: ../../CHANGELOG.rst \ No newline at end of file +.. include:: ../../CHANGELOG.md + :parser: recommonmark diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 8cb3146..370e0c0 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -1 +1,2 @@ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file +.. include:: ../../CONTRIBUTING.md + :parser: recommonmark diff --git a/docs/source/examples/containers/index.rst b/docs/source/examples/containers/index.rst index 324ce2f..111d3a3 100644 --- a/docs/source/examples/containers/index.rst +++ b/docs/source/examples/containers/index.rst @@ -17,4 +17,5 @@ This section contains examples demonstrating how to work with containers in Verd scaling inference_async inference_sync - inference_minimal \ No newline at end of file + inference_minimal + inference_minimal_async