working sphinx html build

Author: Mateusz Wiezik

docs/api_reference.rst

@@ -0,0 +1,91 @@
+
+API Reference
+=============
+
+Overview
+--------
+Athena NodeJS SDK provides real-time image classification for CSAM detection using gRPC. It supports session-based deployments, multi-affiliate collaboration, and a wide range of image formats and error handling features.
+
+Main Classes
+------------
+
+- **ClassifierSdk**: Main entry point for interacting with the Athena service. Handles authentication, deployment management, and image classification.
+- **ClassifierServiceClient**: Low-level gRPC client for direct service calls.
+- **ClassifyImageOptions**: Options for sending image classification requests.
+- **Deployment**: Represents a deployment session.
+- **ClassifyRequest** / **ClassifyResponse**: Request and response types for image classification.
+- **ClassificationInput** / **ClassificationOutput** / **ClassificationError** / **Classification**: Types for input, output, and error handling.
+
+Usage Example
+-------------
+
+.. code-block:: javascript
+
+   import { ClassifierSdk } from 'athena-nodejs-sdk';
+
+   const sdk = new ClassifierSdk({
+     deploymentId: 'your-deployment-id',
+     affiliate: 'your-affiliate',
+     authentication: {
+       issuerUrl: 'https://issuer.example.com',
+       clientId: 'your-client-id',
+       clientSecret: 'your-client-secret',
+       scope: 'manage:classify'
+     }
+   });
+
+   await sdk.open();
+   const deployments = await sdk.listDeployments();
+   // Send image for classification
+   await sdk.sendClassifyRequest({
+     imageStream: fs.createReadStream('image.jpg'),
+     format: 'JPEG',
+   });
+
+   sdk.on('data', (response) => {
+     console.log('Classification result:', response);
+   });
+
+   sdk.on('error', (err) => {
+     console.error('Error:', err);
+   });
+
+   sdk.on('close', () => {
+     console.log('Connection closed');
+   });
+
+API Classes
+-----------
+
+.. js:autoclass:: ClassifierSdk
+   :members:
+
+.. js:autoclass:: ClassifierServiceClient
+   :members:
+
+.. js:autointerface:: ClassifyImageOptions
+   :members:
+
+.. js:autointerface:: ListDeploymentsResponse
+   :members:
+
+.. js:autointerface:: Deployment
+   :members:
+
+.. js:autointerface:: ClassifyResponse
+   :members:
+
+.. js:autointerface:: ClassifyRequest
+   :members:
+
+.. js:autointerface:: ClassificationOutput
+   :members:
+
+.. js:autointerface:: ClassificationInput
+   :members:
+
+.. js:autointerface:: ClassificationError
+   :members:
+
+.. js:autointerface:: Classification
+   :members:

docs/conf.py

@@ -60,6 +60,10 @@
     "**/.pytest_cache/**",
     "**/.mypy_cache/**",
     "**/.ruff_cache/**",
+    # Exclude files with duplicate documented objects
+    "../src/athena/google/protobuf/empty.ts",
+    "../src/athena/athena.ts",
+
 ]
 
 # The theme to use for HTML and HTML Help pages

docs/index.rst

@@ -15,3 +15,5 @@ documentation for details.
    :maxdepth: 2
    :caption: Contents:
 
+   api_reference
+

pyproject.toml

@@ -5,7 +5,7 @@ description = "NodeJS SDK documentation for Athena CSAM Detection API"
 authors = [{ name = "Crisp", email = "support@crispthinking.com" }]
 readme = "README.md"
 license = { text = "MIT" }
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
@@ -25,15 +25,16 @@ dependencies = [
     "sphinx>=7.0.0",
     "sphinx-rtd-theme>=1.3.0",
     "myst-parser>=2.0.0",
-
     # Extensions for enhanced documentation
     "sphinx-autobuild>=2021.3.14",
     "sphinxcontrib-spelling>=8.0.0",
-
+    # Sphinx JS extension
+    "sphinx-js>=4.1.0",
     # Protocol buffer support
     "protobuf>=4.0.0",
     "grpcio>=1.50.0",
     "grpcio-tools>=1.50.0",
+    "furo>=2025.7.19",
 ]
 
 [project.optional-dependencies]

src/main.ts

@@ -265,6 +265,20 @@ export class ClassifierSdk extends (EventEmitter as new () => TypedEmitter<Class
   }
 }
 
-export * from './athena/athena';
-export * from './athena/athena.grpc-client';
+export {
+  ListDeploymentsResponse,
+  Deployment,
+  ClassifyRequest,
+  ClassificationInput,
+  ClassifyResponse,
+  ClassificationOutput,
+  Classification,
+  ClassificationError,
+  ImageHash,
+  ErrorCode,
+  RequestEncoding,
+  ImageFormat,
+  HashType
+} from './athena/athena';
+export { ClassifierServiceClient, IClassifierServiceClient } from './athena/athena.grpc-client';
 export * from './hashing';

typedoc.json

@@ -1,6 +1,8 @@
 {
   "excludeExternals": true,
   "exclude": [
-    "src/athena/google/*"
+    "src/athena/google/*",
+    "src/athena/athena.ts",
+    "src/athena/google/protobuf/empty.ts"
   ]
 }