[PLT-0] Breakup docs/source to docs/labelbox (#1503)

adrian-chang · Adrian Chang · web-flow · commit bfedb6ec7049 · 2024-03-26T12:14:59.000-07:00
Co-authored-by: Adrian Chang &lt;achang@labelbox.com&gt;
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -12,7 +12,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/source/conf.py
+   configuration: docs/conf.py
 
 # Not building additional formats, as PDF build is failing
 # formats: 
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,7 +9,6 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
 import sys
 
@@ -18,9 +17,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Python SDK reference'
-copyright = '2021, Labelbox'
+copyright = '2024, Labelbox'
 author = 'Labelbox'
-
 release = '3.66.0'
 
 # -- General configuration ---------------------------------------------------
@@ -29,7 +27,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon'
+    'multiproject', 'sphinx.ext.autodoc', 'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon', 'sphinx_rtd_theme'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -40,6 +39,8 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
+multiproject_projects = {"labelbox": {"path": "labelbox"}}
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -50,10 +51,9 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # Prevent the sidebar from collapsing
-html_js_files = ['js/prevent_collapse.js']
 html_theme_options = {
     "collapse_navigation": False,
-}
+}
diff --git a/docs/labelbox/annotation-import.rst b/docs/labelbox/annotation-import.rst
@@ -0,0 +1,7 @@
+Annotation Import
+===============================================================================================
+
+.. automodule:: labelbox.schema.annotation_import
+   :members:
+   :show-inheritance:
+
diff --git a/docs/labelbox/app.rst b/docs/labelbox/app.rst
@@ -0,0 +1,6 @@
+App
+===============================================================================================
+
+.. automodule:: labelbox.schema.foundry.app
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/asset-attachment.rst b/docs/labelbox/asset-attachment.rst
@@ -0,0 +1,6 @@
+Asset Attachment
+===============================================================================================
+
+.. automodule:: labelbox.schema.asset_attachment
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/batch.rst b/docs/labelbox/batch.rst
@@ -0,0 +1,6 @@
+Batch
+===============================================================================================
+
+.. automodule:: labelbox.schema.batch
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/benchmark.rst b/docs/labelbox/benchmark.rst
@@ -0,0 +1,6 @@
+Benchmark
+===============================================================================================
+
+.. automodule:: labelbox.schema.benchmark
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/bulk-import-request.rst b/docs/labelbox/bulk-import-request.rst
@@ -0,0 +1,7 @@
+Bulk Import Request
+===============================================================================================
+
+.. automodule:: labelbox.schema.bulk_import_request
+   :members:
+   :exclude-members: create_from_local_file, create_from_objects, create_from_url, from_name
+   :show-inheritance:
diff --git a/docs/labelbox/client.rst b/docs/labelbox/client.rst
@@ -0,0 +1,8 @@
+Client
+===============================================================================================
+
+.. automodule:: labelbox.client
+   :members:
+   :special-members: __init__
+   :exclude-members: upload_data, upload_file
+   :show-inheritance:
diff --git a/docs/labelbox/conf.py b/docs/labelbox/conf.py
diff --git a/docs/labelbox/conflict-resolution-strategy.rst b/docs/labelbox/conflict-resolution-strategy.rst
@@ -0,0 +1,5 @@
+Conflict Resolution Strategy
+===============================================================================================
+.. automodule:: labelbox.schema.conflict_resolution_strategy
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/datarow-metadata.rst b/docs/labelbox/datarow-metadata.rst
@@ -0,0 +1,7 @@
+DataRow Metadata
+===============================================================================================
+
+.. automodule:: labelbox.schema.data_row_metadata
+   :members:
+   :exclude-members: _DeleteBatchDataRowMetadata
+   :show-inheritance:
diff --git a/docs/labelbox/datarow.rst b/docs/labelbox/datarow.rst
@@ -0,0 +1,5 @@
+DataRow
+===============================================================================================
+.. automodule:: labelbox.schema.data_row
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/dataset.rst b/docs/labelbox/dataset.rst
@@ -0,0 +1,6 @@
+Dataset
+===============================================================================================
+
+.. automodule:: labelbox.schema.dataset
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/enums.rst b/docs/labelbox/enums.rst
@@ -0,0 +1,6 @@
+Enums
+===============================================================================================
+
+.. automodule:: labelbox.schema.enums
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/exceptions.rst b/docs/labelbox/exceptions.rst
@@ -0,0 +1,6 @@
+Exceptions
+===============================================================================================
+
+.. automodule:: labelbox.exceptions
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/export-task.rst b/docs/labelbox/export-task.rst
@@ -0,0 +1,7 @@
+Export Task
+===============================================================================================
+
+.. automodule:: labelbox.schema.export_task
+   :members:
+   :exclude-members: FileRetrieverByLine, FileRetrieverByOffset, FileRetrieverStrategy, Range, Converter
+   :show-inheritance:
diff --git a/docs/labelbox/foundry-client.rst b/docs/labelbox/foundry-client.rst
@@ -0,0 +1,6 @@
+Foundry Client
+===============================================================================================
+
+.. automodule:: labelbox.schema.foundry.foundry_client
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/foundry-model.rst b/docs/labelbox/foundry-model.rst
@@ -0,0 +1,6 @@
+Foundry Model
+===============================================================================================
+
+.. automodule:: labelbox.schema.foundry.model
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/identifiable.rst b/docs/labelbox/identifiable.rst
@@ -0,0 +1,6 @@
+Identifiable
+===============================================================================================
+
+.. automodule:: labelbox.schema.identifiable
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/identifiables.rst b/docs/labelbox/identifiables.rst
@@ -0,0 +1,6 @@
+Identifiables
+===============================================================================================
+
+.. automodule:: labelbox.schema.identifiables
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/index.rst b/docs/labelbox/index.rst
@@ -0,0 +1,44 @@
+Labelbox Python SDK Documentation
+===============================================================================================
+
+..  toctree::
+    :maxdepth: 3
+    :caption: Contents:
+        
+    annotation-import
+    app
+    asset-attachment
+    batch
+    benchmark
+    bulk-import-request
+    client
+    conflict-resolution-strategy
+    datarow
+    datarow-metadata
+    dataset
+    enums
+    exceptions
+    export-task
+    foundry-client
+    foundry-model
+    identifiable
+    identifiables
+    label
+    labeling-frontend
+    labeling-frontend-options
+    labeling-parameter-override
+    model
+    model-run
+    ontology
+    organization
+    pagination
+    project
+    quality-mode
+    resource-tag
+    review
+    send-to-annotate-params
+    slice
+    task
+    task-queue
+    user
+    webhook
diff --git a/docs/labelbox/label.rst b/docs/labelbox/label.rst
@@ -0,0 +1,6 @@
+Label
+===============================================================================================
+
+.. automodule:: labelbox.schema.label
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/labeling-frontend-options.rst b/docs/labelbox/labeling-frontend-options.rst
@@ -0,0 +1,8 @@
+Labeling Frontend Options
+===============================================================================================
+
+.. automodule:: labelbox.schema.labeling_frontend
+   :members: LabelingFrontendOptions
+   :exclude-members: LabelingFrontend
+   :show-inheritance:
+   :noindex:
diff --git a/docs/labelbox/labeling-frontend.rst b/docs/labelbox/labeling-frontend.rst
@@ -0,0 +1,7 @@
+Labeling Frontend
+===============================================================================================
+
+.. automodule:: labelbox.schema.labeling_frontend
+   :members: LabelingFrontend
+   :exclude-members: LabelingFrontendOptions
+   :show-inheritance:
diff --git a/docs/labelbox/labeling-parameter-override.rst b/docs/labelbox/labeling-parameter-override.rst
@@ -0,0 +1,7 @@
+Labeling Parameter Override
+===============================================================================================
+
+.. automodule:: labelbox.schema.project
+    :members: LabelingParameterOverride
+    :show-inheritance:
+    :noindex:
diff --git a/docs/labelbox/model-run.rst b/docs/labelbox/model-run.rst
@@ -0,0 +1,6 @@
+Model Run
+===============================================================================================
+
+.. automodule:: labelbox.schema.model_run
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/model.rst b/docs/labelbox/model.rst
@@ -0,0 +1,6 @@
+Model
+===============================================================================================
+
+.. automodule:: labelbox.schema.model
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/ontology.rst b/docs/labelbox/ontology.rst
@@ -0,0 +1,7 @@
+Ontology
+===============================================================================================
+
+.. automodule:: labelbox.schema.ontology
+   :members:
+   :exclude-members: OntologyEntity, Classification, Tool, Option
+   :show-inheritance:
diff --git a/docs/labelbox/organization.rst b/docs/labelbox/organization.rst
@@ -0,0 +1,6 @@
+Organization
+===============================================================================================
+
+.. automodule:: labelbox.schema.organization
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/pagination.rst b/docs/labelbox/pagination.rst
@@ -0,0 +1,7 @@
+Pagination
+===============================================================================================
+
+.. automodule:: labelbox.pagination
+   :members:
+   :special-members: __init__
+   :show-inheritance:
diff --git a/docs/labelbox/project.rst b/docs/labelbox/project.rst
@@ -0,0 +1,7 @@
+Project
+===============================================================================================
+
+.. automodule:: labelbox.schema.project
+   :members:
+   :exclude-members: LabelerPerformance, LabelingParameterOverride
+   :show-inheritance:
diff --git a/docs/labelbox/quality-mode.rst b/docs/labelbox/quality-mode.rst
@@ -0,0 +1,6 @@
+Quality Mode
+===============================================================================================
+
+.. automodule:: labelbox.schema.quality_mode
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/resource-tag.rst b/docs/labelbox/resource-tag.rst
@@ -0,0 +1,6 @@
+Resource Tag
+===============================================================================================
+
+.. automodule:: labelbox.schema.resource_tag
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/review.rst b/docs/labelbox/review.rst
@@ -0,0 +1,6 @@
+Review
+===============================================================================================
+
+.. automodule:: labelbox.schema.review
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/send-to-annotate-params.rst b/docs/labelbox/send-to-annotate-params.rst
@@ -0,0 +1,6 @@
+Send To Annotate Params
+===============================================================================================
+
+.. automodule:: labelbox.schema.send_to_annotate_params
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/slice.rst b/docs/labelbox/slice.rst
@@ -0,0 +1,6 @@
+Slice
+===============================================================================================
+
+.. automodule:: labelbox.schema.slice
+   :members:
+   :show-inheritance:
diff --git a/docs/labelbox/task-queue.rst b/docs/labelbox/task-queue.rst
diff --git a/docs/labelbox/task.rst b/docs/labelbox/task.rst
diff --git a/docs/labelbox/user.rst b/docs/labelbox/user.rst
diff --git a/docs/labelbox/webhook.rst b/docs/labelbox/webhook.rst
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/_static/js/prevent_collapse.js b/docs/source/_static/js/prevent_collapse.js
diff --git a/docs/source/index.rst b/docs/source/index.rst
