21632: Removes references to OpenAPI client while keeping Feature Att…

…ributes documentation (#82) With the changes to howso-engine-py, the OpenAPI client has been removed so the references to that package needs to be removed from the docs. However, this was one of the best sources of documentation for the feature attributes, I alter the OpenAPI pages to only keep the feature attributes information and rename the section to FeatureAttributes while removing the bits that define it as being under `howso.openapi`
howsoai · Sep 23, 2024 · c4de58a · c4de58a
1 parent 4236386
commit c4de58a
Show file tree

Hide file tree

Showing 15 changed files with 17 additions and 1,157 deletions.
diff --git a/bin/build.sh b/bin/build.sh
@@ -55,7 +55,6 @@ gen_licenses() {
   # Removing our own - since they aren't 3rd party
   pip uninstall -y howso-engine
   pip uninstall -y amalgam-lang
-  pip uninstall -y howso-openapi-client
   pip install pip-licenses
   pip-licenses --with-authors --with-urls --with-license-file --with-description --format=plain-vertical  > ./LICENSE-3RD-PARTY.txt
   # Include any additional non-generated licenses

diff --git a/requirements-3.8.txt b/requirements-3.8.txt
diff --git a/source/api_reference/data_structures.rst b/source/api_reference/data_structures.rst
diff --git a/source/api_reference/feature_attributes.rst b/source/api_reference/feature_attributes.rst
@@ -0,0 +1,14 @@
+Feature Attributes
+==================
+
+Feature attributes are the foundational data structure used to define features and their properties for the Howso Engine.
+Feature attributes can be generated inferred automatically using :py:meth:`~howso.utilities.infer_feature_attributes`, but
+users are encouraged to manually inspect the resulting attributes and make any necessary changes.
+
+See the full definition of all feature attributes in the pages below.
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+
+    /howso/types/*
diff --git a/source/api_reference/index.rst b/source/api_reference/index.rst
@@ -34,10 +34,10 @@ These packages are for internal use and are not recommended for inexperienced us
     howso.direct
 
 
-Other Packages
---------------
+Feature Attributes
+------------------
 
 .. toctree::
     :maxdepth: 2
 
-    data_structures
+    feature_attributes
diff --git a/source/openapi/types/FeatureAttributes.md → source/howso/types/FeatureAttributes.md b/source/openapi/types/FeatureAttributes.md → source/howso/types/FeatureAttributes.md
@@ -2,8 +2,6 @@
 
 # FeatureAttributes
 
-`````{py:module} howso.openapi.models
-:noindex:
 
 ````{py:class} FeatureAttributes
 
@@ -186,4 +184,3 @@ Flag feature as only having unique values. Only applicable to nominals features.
 ```
 
 ````
-`````
diff --git a/...openapi/types/FeatureAutoDeriveOnTrain.md → ...e/howso/types/FeatureAutoDeriveOnTrain.md b/...openapi/types/FeatureAutoDeriveOnTrain.md → ...e/howso/types/FeatureAutoDeriveOnTrain.md
@@ -1,8 +1,6 @@
 <!-- Auto-generated do not edit -->
 # FeatureAutoDeriveOnTrain
 
-`````{py:module} howso.openapi.models
-:noindex:
 
 ````{py:class} FeatureAutoDeriveOnTrain
 
@@ -36,4 +34,3 @@ Feature name(s) by which to order the series specified by `series_id_features`.
 ```
 
 ````
-`````
diff --git a/...i/types/FeatureAutoDeriveOnTrainCustom.md → ...o/types/FeatureAutoDeriveOnTrainCustom.md b/...i/types/FeatureAutoDeriveOnTrainCustom.md → ...o/types/FeatureAutoDeriveOnTrainCustom.md
@@ -1,8 +1,6 @@
 <!-- Auto-generated do not edit -->
 # FeatureAutoDeriveOnTrainCustom
 
-`````{py:module} howso.openapi.models
-:noindex:
 
 ````{py:class} FeatureAutoDeriveOnTrainCustom
 
@@ -40,4 +38,3 @@ Feature name(s) by which to order the series specified by `series_id_features`.
 ```
 
 ````
-`````
diff --git a/...types/FeatureAutoDeriveOnTrainProgress.md → ...types/FeatureAutoDeriveOnTrainProgress.md b/...types/FeatureAutoDeriveOnTrainProgress.md → ...types/FeatureAutoDeriveOnTrainProgress.md
@@ -1,8 +1,6 @@
 <!-- Auto-generated do not edit -->
 # FeatureAutoDeriveOnTrainProgress
 
-`````{py:module} howso.openapi.models
-:noindex:
 
 ````{py:class} FeatureAutoDeriveOnTrainProgress
 
@@ -23,4 +21,3 @@ Feature name(s) of series for which to derive this feature. A series is the conj
 ```
 
 ````
-`````
diff --git a/source/openapi/types/FeatureBounds.md → source/howso/types/FeatureBounds.md b/source/openapi/types/FeatureBounds.md → source/howso/types/FeatureBounds.md
@@ -1,8 +1,6 @@
 <!-- Auto-generated do not edit -->
 # FeatureBounds
 
-`````{py:module} howso.openapi.models
-:noindex:
 
 ````{py:class} FeatureBounds
 
@@ -33,4 +31,3 @@ Allow nulls to be output, per their distribution in the data. Defaults to true.
 ```
 
 ````
-`````
diff --git a/source/openapi/types/FeatureOriginalType.md → source/howso/types/FeatureOriginalType.md b/source/openapi/types/FeatureOriginalType.md → source/howso/types/FeatureOriginalType.md
@@ -1,8 +1,6 @@
 <!-- Auto-generated do not edit -->
 # FeatureOriginalType
 
-`````{py:module} howso.openapi.models
-:noindex:
 
 ````{py:class} FeatureOriginalType
 
@@ -57,4 +55,3 @@ The unit of the time delta.
 ```
 
 ````
-`````
diff --git a/source/openapi/types/FeatureTimeSeries.md → source/howso/types/FeatureTimeSeries.md b/source/openapi/types/FeatureTimeSeries.md → source/howso/types/FeatureTimeSeries.md
@@ -2,8 +2,6 @@
 
 # FeatureTimeSeries
 
-`````{py:module} howso.openapi.models
-:noindex:
 
 ````{py:class} FeatureTimeSeries
 
@@ -95,4 +93,3 @@ When true, the feature will be treated as the time feature for time series model
 ```
 
 ````
-`````
diff --git a/source/openapi/types/Cases.md b/source/openapi/types/Cases.md
diff --git a/versions.in b/versions.in
@@ -1,3 +1,2 @@
 howso-engine
 amalgam-lang
-howso-openapi-client
diff --git a/versions.properties b/versions.properties
@@ -1,4 +1,3 @@
 amalgam_lang=2.3.18
 howso_engine=1.1.46
 howso_engine_api=7.1.0
-howso_openapi_client=24.0.15