Skip to content

Commit

Permalink
Merge hsfs mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
aversey committed Jul 14, 2024
1 parent 437bd19 commit 5673e5b
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 144 deletions.
130 changes: 0 additions & 130 deletions hsfs/mkdocs.yml

This file was deleted.

12 changes: 0 additions & 12 deletions hsfs/requirements-docs.txt

This file was deleted.

29 changes: 28 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,36 @@ nav:
- KafkaSchema: generated/api/kafka_schema.md
- Secrets: generated/api/secrets.md
- OpenSearch: generated/api/opensearch.md
- Feature Store API Reference:
- Connection: generated/api/connection_api.md
- ExpectationSuite: generated/api/expectation_suite_api.md
- FeatureStore: generated/api/feature_store_api.md
- FeatureGroup: generated/api/feature_group_api.md
- ExternalFeatureGroup: generated/api/external_feature_group_api.md
- SpineGroup: generated/api/spine_group_api.md
- FeatureView: generated/api/feature_view_api.md
- TrainingDataset: generated/api/training_dataset_api.md
- Storage Connector: generated/api/storage_connector_api.md
- Feature: generated/api/feature_api.md
- Query: generated/api/query_api.md
- Transformation Functions: generated/api/transformation_functions_api.md
- ValidationReport: generated/api/validation_report_api.md
- Job: generated/api/job.md
- Provenance Links: generated/api/links.md
- Statistics:
- Statistics: generated/api/statistics_api.md
- Split Statistics: generated/api/split_statistics_api.md
- Feature descriptive statistics: generated/api/feature_descriptive_statistics_api.md
- Feature Monitoring:
- Configuration: generated/api/feature_monitoring_config_api.md
- Result: generated/api/feature_monitoring_result_api.md
- Window: generated/api/feature_monitoring_window_config_api.md
- Embedding:
- EmbeddingIndex: generated/api/embedding_index_api.md
- EmbeddingFeature: generated/api/embedding_feature_api.md
- SimilarityFunctionType: generated/api/similarity_function_type_api.md
# Added to allow navigation using the side drawer
- Hopsworks API: https://docs.hopsworks.ai/hopsworks-api/latest/
- MLOps API: https://docs.hopsworks.ai/machine-learning-api/latest/
- Feature Store JavaDoc: https://docs.hopsworks.ai/feature-store-javadoc/latest/
- Contributing: CONTRIBUTING.md
- Community ↗: https://community.hopsworks.ai/
Expand Down
2 changes: 1 addition & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
mkdocs==1.5.3
mkdocs-material==9.5.17
mike==2.0.0
sphinx==7.2.6
sphinx==7.3.7
keras_autodoc @ git+https://[email protected]/logicalclocks/keras-autodoc
markdown-include==0.8.1
mkdocs-jupyter==0.24.3
Expand Down

0 comments on commit 5673e5b

Please sign in to comment.