user_workspaces_server.sphinx_ext package

Submodules

user_workspaces_server.sphinx_ext.json_schema_autodoc module

Sphinx extension for automatic configuration documentation from JSON schemas.

This extension generates RST documentation from JSON Schema definitions, keeping documentation in sync with validation rules automatically.

user_workspaces_server.sphinx_ext.json_schema_autodoc.generate_field_doc(field_name, field_def, is_required, indent=0)

Generate RST documentation for a single configuration field.

Parameters:

• field_name (str) – Name of the field

• field_def (Dict[str, Any]) – JSON Schema field definition

• is_required (bool) – Whether the field is required

• indent (int) – Indentation level

Return type:

str

Returns:

RST formatted string documenting the field

user_workspaces_server.sphinx_ext.json_schema_autodoc.generate_controller_doc(schema)

Generate RST documentation for a controller schema.

Parameters:

schema (JSONSchemaWrapper) – The JSON schema wrapper

Return type:

str

Returns:

RST formatted string documenting the controller

user_workspaces_server.sphinx_ext.json_schema_autodoc.generate_category_doc(category, schemas)

Generate RST documentation for a category of controllers.

Parameters:

• category (str) – Category name (resources, storage, authentication, job_types)

• schemas (Dict[str, JSONSchemaWrapper]) – Dictionary of JSON schemas in this category

Return type:

str

Returns:

RST formatted string documenting all controllers in the category

user_workspaces_server.sphinx_ext.json_schema_autodoc.generate_config_reference(output_dir)

Generate complete configuration reference documentation.

Parameters:

output_dir (str) – Directory to write documentation files

user_workspaces_server.sphinx_ext.json_schema_autodoc.builder_inited(app)

Sphinx event handler called when builder is initialized.

Generates configuration documentation before Sphinx processes it.

user_workspaces_server.sphinx_ext.json_schema_autodoc.setup(app)

Sphinx extension setup function.

Parameters:

app (Sphinx) – Sphinx application instance

Return type:

Dict[str, Any]

Returns:

Extension metadata

Module contents

Sphinx extensions for User Workspaces Server documentation.