Skip to content

Update docs building instructions in readme #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
freetonik wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update docs building instructions in readme #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
851fec8
Update docs building instructions in readme
freetonik Dec 9, 2025
22f867c
Use uv dev group for docs
Dec 9, 2025
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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,12 @@ uv run python example.py

### Generating the documentation

If added a new service, create a documentation template under api/services for that service.
If added a new service, create a documentation template under `api/services` for that service.

```bash
uv sync --group docs
cd docs
make html
uv run make html
Copy link
Collaborator

@shamrin shamrin Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move these to top-level pyproject.toml, using separate docs dependency group?

Copy link
Author

@freetonik freetonik Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed the change. TBH I prefer putting that all into one group (not dev + docs like now); uv sync --group dev after installing docs deps removes the docs dependencies. You need to do uv sync --all-groups or uv sync --group docs --group dev to keep both.

Copy link
Author

@freetonik freetonik Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also applies the suggestions I made to another MR #65
So if this one is merged, the other one can be closed.

```

### Code style
Expand Down
2 changes: 0 additions & 2 deletions docs/requirements.txt
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions docs/source/api/services/balance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/source/api/services/containers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

4 changes: 2 additions & 2 deletions docs/source/api/services/images.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/source/api/services/instance_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/source/api/services/instances.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/source/api/services/ssh_keys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/source/api/services/startup_scripts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/source/api/services/volume_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/source/api/services/volumes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
5 changes: 5 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ dev = [
"ruff>=0.14.2",
]

docs = [
"sphinx>=7.0.0",
"recommonmark>=0.7.1",
]

[project.urls]
Homepage = "https://github.com/verda-cloud"
Documentation = "https://datacrunch-python.readthedocs.io/"
Expand Down
320 changes: 320 additions & 0 deletions uv.lock
View file
Open in desktop

Large diffs are not rendered by default.