Skip to content

Commit e22f7b2

Browse files
jeremymanningclaude
andcommitted
Fix all documentation build errors
- Fixed docstring indentation errors by using proper RST syntax (::) - Fixed cost_tracking_decorator Example section formatting - Fixed ClusterfyMagics.clusterfy Usage section formatting - Added proper module-level documentation for DEFAULT_CONFIGS using #: syntax - Fixed RST title underline lengths in config.rst - Removed trailing spaces from "Cluster Settings" title Documentation now builds without any errors or warnings. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 1c08a19 commit e22f7b2

File tree

6 files changed

+16
-7
lines changed

6 files changed

+16
-7
lines changed

clustrix/cost_monitoring.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,8 @@ def cost_tracking_decorator(provider: str, instance_type: str = "default"):
257257
provider: Cloud provider name (e.g., 'lambda', 'aws', 'azure', 'gcp')
258258
instance_type: Instance type for cost estimation
259259
260-
Example:
260+
Example::
261+
261262
@cost_tracking_decorator('lambda', 'a100_40gb')
262263
@cluster(cores=8, memory="32GB")
263264
def my_training_function():

clustrix/notebook_magic.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,11 @@ class widgets: # type: ignore
185185
from .config import configure, get_config
186186

187187
logger = logging.getLogger(__name__)
188-
# Default cluster configurations
188+
189+
#: Default cluster configurations available in the widget.
190+
#:
191+
#: This dictionary contains pre-configured cluster templates for common use cases.
192+
#: Each configuration is a dictionary with cluster-specific settings.
189193
DEFAULT_CONFIGS = {
190194
"Local Single-core": {
191195
"cluster_type": "local",
@@ -2363,9 +2367,13 @@ class ClusterfyMagics(Magics):
23632367
def clusterfy(self, line, cell):
23642368
"""
23652369
Create an interactive widget for managing Clustrix configurations.
2366-
Usage:
2370+
2371+
Usage::
2372+
23672373
%%clusterfy
2374+
23682375
This creates a widget interface that allows you to:
2376+
23692377
- Select and manage cluster configurations
23702378
- Create new configurations with validation
23712379
- Save/load configurations from files
-1.61 KB
Binary file not shown.
-488 Bytes
Binary file not shown.
-2.72 KB
Binary file not shown.

docs/source/api/config.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Clustrix provides flexible configuration management for cluster settings, authen
99
:show-inheritance:
1010

1111
Configuration Methods
12-
--------------------
12+
---------------------
1313

1414
Programmatic Configuration
15-
~~~~~~~~~~~~~~~~~~~~~~~~~
15+
~~~~~~~~~~~~~~~~~~~~~~~~~~
1616

1717
.. code-block:: python
1818
@@ -79,8 +79,8 @@ Authentication
7979
- ``password``: SSH password (not recommended)
8080
- ``key_file``: Path to SSH private key file
8181

82-
Cluster Settings
83-
~~~~~~~~~~~~~~~
82+
Cluster Settings
83+
~~~~~~~~~~~~~~~~
8484

8585
- ``cluster_type``: Type of cluster (slurm, pbs, sge, kubernetes, ssh)
8686
- ``cluster_host``: Hostname of cluster head node

0 commit comments

Comments
 (0)