From bd8b0c9e3ba31cd7d796639a6c747ac7ad0e132a Mon Sep 17 00:00:00 2001
From: Mike Conley <mconley@mozilla.com>
Date: Tue, 6 Dec 2022 17:50:40 +0000
Subject: [PATCH] Bug 1802961 - Generate documentation for the
 browser/components/migration component. r=kpatenio

Differential Revision: https://phabricator.services.mozilla.com/D163258
---
 browser/components/migration/docs/index.rst   | 16 ++++
 .../migration/docs/migration-utils.rst        |  5 ++
 .../migration/docs/migration-wizard.rst       | 13 +++
 .../components/migration/docs/migrators.rst   | 88 +++++++++++++++++++
 browser/components/migration/moz.build        |  2 +
 browser/docs/index.rst                        |  1 +
 docs/conf.py                                  |  1 +
 7 files changed, 126 insertions(+)
 create mode 100644 browser/components/migration/docs/index.rst
 create mode 100644 browser/components/migration/docs/migration-utils.rst
 create mode 100644 browser/components/migration/docs/migration-wizard.rst
 create mode 100644 browser/components/migration/docs/migrators.rst

diff --git a/browser/components/migration/docs/index.rst b/browser/components/migration/docs/index.rst
new file mode 100644
index 000000000000..be22b951cb0b
--- /dev/null
+++ b/browser/components/migration/docs/index.rst
@@ -0,0 +1,16 @@
+.. _components/migration:
+
+=========
+Migration
+=========
+
+The migration component is responsible for bringing data from outside applications running on the same computer into Firefox. This is typically done via a wizard where users can choose what types of data to migrate over.
+
+The migrator is also used during a "Profile Refresh" to pave over a newly created Firefox profile with some data from an older one.
+
+.. toctree::
+   :maxdepth: 3
+
+   migration-utils
+   migrators
+   migration-wizard
diff --git a/browser/components/migration/docs/migration-utils.rst b/browser/components/migration/docs/migration-utils.rst
new file mode 100644
index 000000000000..c1ecb41d8b32
--- /dev/null
+++ b/browser/components/migration/docs/migration-utils.rst
@@ -0,0 +1,5 @@
+========================
+MigrationUtils Reference
+========================
+.. js:autoclass:: MigrationUtils
+  :members:
diff --git a/browser/components/migration/docs/migration-wizard.rst b/browser/components/migration/docs/migration-wizard.rst
new file mode 100644
index 000000000000..ee628ff5f244
--- /dev/null
+++ b/browser/components/migration/docs/migration-wizard.rst
@@ -0,0 +1,13 @@
+==========================
+Migration Wizard Reference
+==========================
+
+MigrationWizardParent class
+===========================
+.. js:autoclass:: MigrationWizardParent
+  :members:
+
+MigrationWizardChild class
+==========================
+.. js:autoclass:: MigrationWizardChild
+  :members:
diff --git a/browser/components/migration/docs/migrators.rst b/browser/components/migration/docs/migrators.rst
new file mode 100644
index 000000000000..ab91cbc18707
--- /dev/null
+++ b/browser/components/migration/docs/migrators.rst
@@ -0,0 +1,88 @@
+===================
+Migrators Reference
+===================
+
+MigratorBase class
+------------------
+.. js:autoclass:: MigratorBase
+  :members:
+
+Chrome and Chrome variant migrators
+-----------------------------------
+
+The ``ChromeProfileMigrator`` is subclassed ino order to provide migration capabilities for variants of the Chrome browser.
+
+ChromeProfileMigrator class
+===========================
+.. js:autoclass:: ChromeProfileMigrator
+  :members:
+
+BraveProfileMigrator class
+==========================
+.. js:autoclass:: BraveProfileMigrator
+  :members:
+
+CanaryProfileMigrator class
+===========================
+.. js:autoclass:: CanaryProfileMigrator
+  :members:
+
+ChromeBetaMigrator class
+========================
+.. js:autoclass:: ChromeBetaMigrator
+  :members:
+
+ChromeDevMigrator class
+=======================
+.. js:autoclass:: ChromeDevMigrator
+  :members:
+
+Chromium360seMigrator class
+===========================
+.. js:autoclass:: Chromium360seMigrator
+  :members:
+
+ChromiumEdgeMigrator class
+==========================
+.. js:autoclass:: ChromiumEdgeMigrator
+  :members:
+
+ChromiumEdgeBetaMigrator class
+==============================
+.. js:autoclass:: ChromiumEdgeBetaMigrator
+  :members:
+
+ChromiumProfileMigrator class
+=============================
+.. js:autoclass:: ChromiumProfileMigrator
+  :members:
+
+OperaProfileMigrator class
+==========================
+.. js:autoclass:: OperaProfileMigrator
+  :members:
+
+OperaGXProfileMigrator class
+==========================
+.. js:autoclass:: OperaGXProfileMigrator
+  :members:
+
+VivaldiProfileMigrator class
+============================
+.. js:autoclass:: VivaldiProfileMigrator
+  :members:
+
+EdgeProfileMigrator class
+-------------------------
+.. js:autoclass:: EdgeProfileMigrator
+  :members:
+
+FirefoxProfileMigrator class
+----------------------------
+.. js:autoclass:: FirefoxProfileMigrator
+  :members:
+
+IEProfileMigrator class
+-----------------------
+.. js:autoclass:: IEProfileMigrator
+  :members:
diff --git a/browser/components/migration/moz.build b/browser/components/migration/moz.build
index e756b2685cb1..dcd31d8527ec 100644
--- a/browser/components/migration/moz.build
+++ b/browser/components/migration/moz.build
@@ -10,6 +10,8 @@ MARIONETTE_UNIT_MANIFESTS += ["tests/marionette/manifest.ini"]
 
 MOCHITEST_CHROME_MANIFESTS += ["tests/chrome/chrome.ini"]
 
+SPHINX_TREES["docs"] = "docs"
+
 JAR_MANIFESTS += ["jar.mn"]
 
 XPIDL_SOURCES += [
diff --git a/browser/docs/index.rst b/browser/docs/index.rst
index 95caaa75b249..b8f18315ea48 100644
--- a/browser/docs/index.rst
+++ b/browser/docs/index.rst
@@ -17,6 +17,7 @@ This is the nascent documentation of the Firefox front-end code.
    installer/windows/installer/index
    components/attribution/docs/index
    /toolkit/mozapps/defaultagent/default-browser-agent/index
+   components/migration/docs/index
    components/pagedata/docs/index
    places/index
    components/newtab/content-src/asrouter/docs/index
diff --git a/docs/conf.py b/docs/conf.py
index 477743dee5c3..45a7aa9c7403 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -53,6 +53,7 @@ extensions = [
 # tree-wide (the default) will not work currently.
 js_source_path = [
     "../browser/components/extensions",
+    "../browser/components/migration",
     "../browser/components/uitour",
     "../browser/components/urlbar",
     "../remote/marionette",