From 2bfd11554bf240ca54808223707e0876a6b5a064 Mon Sep 17 00:00:00 2001 From: kovacsv Date: Sat, 14 Jan 2023 22:37:54 +0100 Subject: [PATCH] Add migration guide to the documentation #353 --- docs/Class_Camera.html | 1 + docs/Class_EdgeSettings.html | 1 + docs/Class_EmbeddedViewer.html | 1 + docs/Class_EnvironmentSettings.html | 1 + docs/Class_InputFile.html | 1 + docs/Class_RGBAColor.html | 1 + docs/Class_RGBColor.html | 1 + docs/Enum_CameraMode.html | 1 + docs/Enum_FileSource.html | 1 + ...ction_Init3DViewerElementFromFileList.html | 1 + ...nction_Init3DViewerElementFromUrlList.html | 1 + docs/Function_Init3DViewerElements.html | 1 + docs/Function_SetExternalLibLocation.html | 1 + docs/Page_ContributionGuidelines.html | 1 + docs/Page_EnvironmentSetup.html | 1 + docs/Page_Installation.html | 1 + docs/Page_MigrationGuide.html | 79 +++++++++++++++++++ docs/Page_Usage.html | 1 + docs/index.html | 2 + docs/source/MigrationGuide.html | 10 +++ docs/source/config.json | 4 + docs/source/index.html | 1 + 22 files changed, 113 insertions(+) create mode 100644 docs/Page_MigrationGuide.html create mode 100644 docs/source/MigrationGuide.html diff --git a/docs/Class_Camera.html b/docs/Class_Camera.html index ad365b9..f437bae 100644 --- a/docs/Class_Camera.html +++ b/docs/Class_Camera.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Class_EdgeSettings.html b/docs/Class_EdgeSettings.html index 0e7bffe..cf186f0 100644 --- a/docs/Class_EdgeSettings.html +++ b/docs/Class_EdgeSettings.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Class_EmbeddedViewer.html b/docs/Class_EmbeddedViewer.html index 377274b..b59e877 100644 --- a/docs/Class_EmbeddedViewer.html +++ b/docs/Class_EmbeddedViewer.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Class_EnvironmentSettings.html b/docs/Class_EnvironmentSettings.html index 060781d..09fc962 100644 --- a/docs/Class_EnvironmentSettings.html +++ b/docs/Class_EnvironmentSettings.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Class_InputFile.html b/docs/Class_InputFile.html index 087f75c..c5f858d 100644 --- a/docs/Class_InputFile.html +++ b/docs/Class_InputFile.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Class_RGBAColor.html b/docs/Class_RGBAColor.html index b160ec5..88f41f2 100644 --- a/docs/Class_RGBAColor.html +++ b/docs/Class_RGBAColor.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Class_RGBColor.html b/docs/Class_RGBColor.html index c245daa..0f06247 100644 --- a/docs/Class_RGBColor.html +++ b/docs/Class_RGBColor.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Enum_CameraMode.html b/docs/Enum_CameraMode.html index 290b67e..20196c8 100644 --- a/docs/Enum_CameraMode.html +++ b/docs/Enum_CameraMode.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Enum_FileSource.html b/docs/Enum_FileSource.html index 5d2f727..c871add 100644 --- a/docs/Enum_FileSource.html +++ b/docs/Enum_FileSource.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Function_Init3DViewerElementFromFileList.html b/docs/Function_Init3DViewerElementFromFileList.html index da53321..bbaac36 100644 --- a/docs/Function_Init3DViewerElementFromFileList.html +++ b/docs/Function_Init3DViewerElementFromFileList.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Function_Init3DViewerElementFromUrlList.html b/docs/Function_Init3DViewerElementFromUrlList.html index 3d4b1fe..62d67b0 100644 --- a/docs/Function_Init3DViewerElementFromUrlList.html +++ b/docs/Function_Init3DViewerElementFromUrlList.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Function_Init3DViewerElements.html b/docs/Function_Init3DViewerElements.html index 2689fe6..7ea405c 100644 --- a/docs/Function_Init3DViewerElements.html +++ b/docs/Function_Init3DViewerElements.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Function_SetExternalLibLocation.html b/docs/Function_SetExternalLibLocation.html index 1d3c035..d697022 100644 --- a/docs/Function_SetExternalLibLocation.html +++ b/docs/Function_SetExternalLibLocation.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Page_ContributionGuidelines.html b/docs/Page_ContributionGuidelines.html index 45dbc00..a946277 100644 --- a/docs/Page_ContributionGuidelines.html +++ b/docs/Page_ContributionGuidelines.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Page_EnvironmentSetup.html b/docs/Page_EnvironmentSetup.html index 478d918..bafbb1c 100644 --- a/docs/Page_EnvironmentSetup.html +++ b/docs/Page_EnvironmentSetup.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Page_Installation.html b/docs/Page_Installation.html index 8a1d9ff..5b2496a 100644 --- a/docs/Page_Installation.html +++ b/docs/Page_Installation.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/Page_MigrationGuide.html b/docs/Page_MigrationGuide.html new file mode 100644 index 0000000..5159238 --- /dev/null +++ b/docs/Page_MigrationGuide.html @@ -0,0 +1,79 @@ + + + + + + + + + Online 3D Viewer - Migration Guide + + + + + + + + + + + +
+
+

Migration Guide

+ +

This document lists changes in the engine to help you to migrate your code base.

+ +

0.8.21

+ + + +
+
+ + + + diff --git a/docs/Page_Usage.html b/docs/Page_Usage.html index 98088df..f6544bf 100644 --- a/docs/Page_Usage.html +++ b/docs/Page_Usage.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
diff --git a/docs/index.html b/docs/index.html index d268be9..a7aed55 100644 --- a/docs/index.html +++ b/docs/index.html @@ -27,6 +27,7 @@
Engine Usage
+
Contribution
@@ -75,6 +76,7 @@

Contribution

diff --git a/docs/source/MigrationGuide.html b/docs/source/MigrationGuide.html new file mode 100644 index 0000000..dcc928e --- /dev/null +++ b/docs/source/MigrationGuide.html @@ -0,0 +1,10 @@ +

Migration Guide

+ +

This document lists changes in the engine to help you to migrate your code base.

+ +

0.8.21

+ + diff --git a/docs/source/config.json b/docs/source/config.json index 0d48a82..a241289 100644 --- a/docs/source/config.json +++ b/docs/source/config.json @@ -23,6 +23,10 @@ { "name" : "Usage", "url" : "Usage.html" + }, + { + "name" : "Migration Guide", + "url" : "MigrationGuide.html" } ] }, diff --git a/docs/source/index.html b/docs/source/index.html index 5de9c73..20b8094 100644 --- a/docs/source/index.html +++ b/docs/source/index.html @@ -14,6 +14,7 @@

Contribution