Fix external linking in docs (#1980)

(cherry picked from commit 657bbf4)
Lightning-AI · Aug 8, 2023 · a483720 · a483720
1 parent 72cf10c
commit a483720
Show file tree

Hide file tree

Showing 40 changed files with 82 additions and 2 deletions.
diff --git a/docs/source/classification/accuracy.rst b/docs/source/classification/accuracy.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ########
 Accuracy
 ########

diff --git a/docs/source/classification/average_precision.rst b/docs/source/classification/average_precision.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 #################
 Average Precision
 #################

diff --git a/docs/source/classification/exact_match.rst b/docs/source/classification/exact_match.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ###########
 Exact Match
 ###########

diff --git a/docs/source/classification/f1_score.rst b/docs/source/classification/f1_score.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 #########
 F-1 Score
 #########

diff --git a/docs/source/classification/hamming_distance.rst b/docs/source/classification/hamming_distance.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ################
 Hamming Distance
 ################

diff --git a/docs/source/classification/hinge_loss.rst b/docs/source/classification/hinge_loss.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ##########
 Hinge Loss
 ##########

diff --git a/docs/source/classification/jaccard_index.rst b/docs/source/classification/jaccard_index.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 #############
 Jaccard Index
 #############

diff --git a/docs/source/classification/label_ranking_average_precision.rst b/docs/source/classification/label_ranking_average_precision.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ###############################
 Label Ranking Average Precision
 ###############################

diff --git a/docs/source/classification/label_ranking_loss.rst b/docs/source/classification/label_ranking_loss.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ##################
 Label Ranking Loss
 ##################

diff --git a/docs/source/classification/precision_at_fixed_recall.rst b/docs/source/classification/precision_at_fixed_recall.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 #########################
 Precision At Fixed Recall
 #########################

diff --git a/docs/source/classification/precision_recall_curve.rst b/docs/source/classification/precision_recall_curve.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ######################
 Precision Recall Curve
 ######################

diff --git a/docs/source/classification/recall.rst b/docs/source/classification/recall.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ######
 Recall
 ######

diff --git a/docs/source/classification/recall_at_fixed_precision.rst b/docs/source/classification/recall_at_fixed_precision.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 #########################
 Recall At Fixed Precision
 #########################

diff --git a/docs/source/classification/roc.rst b/docs/source/classification/roc.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ###
 ROC
 ###

diff --git a/docs/source/classification/specificity.rst b/docs/source/classification/specificity.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ###########
 Specificity
 ###########

diff --git a/docs/source/classification/specificity_at_sensitivity.rst b/docs/source/classification/specificity_at_sensitivity.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ##########################
 Specificity At Sensitivity
 ##########################

diff --git a/docs/source/detection/complete_intersection_over_union.rst b/docs/source/detection/complete_intersection_over_union.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/object_detection.svg
    :tags: Detection
 
+.. include:: ../links.rst
+
 #######################################
 Complete Intersection Over Union (cIoU)
 #######################################

diff --git a/docs/source/detection/distance_intersection_over_union.rst b/docs/source/detection/distance_intersection_over_union.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/object_detection.svg
    :tags: Detection
 
+.. include:: ../links.rst
+
 #######################################
 Distance Intersection Over Union (dIoU)
 #######################################

diff --git a/docs/source/detection/generalized_intersection_over_union.rst b/docs/source/detection/generalized_intersection_over_union.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/object_detection.svg
    :tags: Detection
 
+.. include:: ../links.rst
+
 ##########################################
 Generalized Intersection Over Union (gIoU)
 ##########################################

diff --git a/docs/source/detection/intersection_over_union.rst b/docs/source/detection/intersection_over_union.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/object_detection.svg
    :tags: Detection
 
+.. include:: ../links.rst
+
 #############################
 Intersection Over Union (IoU)
 #############################

diff --git a/docs/source/detection/modified_panoptic_quality.rst b/docs/source/detection/modified_panoptic_quality.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/image_classification.svg
    :tags: Detection
 
+.. include:: ../links.rst
+
 #########################
 Modified Panoptic Quality
 #########################

diff --git a/docs/source/detection/panoptic_quality.rst b/docs/source/detection/panoptic_quality.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/image_classification.svg
    :tags: Detection
 
+.. include:: ../links.rst
+
 ################
 Panoptic Quality
 ################

diff --git a/docs/source/image/learned_perceptual_image_patch_similarity.rst b/docs/source/image/learned_perceptual_image_patch_similarity.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/image_classification.svg
    :tags: Image
 
+.. include:: ../links.rst
+
 #################################################
 Learned Perceptual Image Patch Similarity (LPIPS)
 #################################################

diff --git a/docs/source/image/spectral_angle_mapper.rst b/docs/source/image/spectral_angle_mapper.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/image_classification.svg
    :tags: Image
 
+.. include:: ../links.rst
+
 #####################
 Spectral Angle Mapper
 #####################

diff --git a/docs/source/multimodal/clip_score.rst b/docs/source/multimodal/clip_score.rst
@@ -3,9 +3,11 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/image_classification.svg
    :tags: Image
 
-############################################
+.. include:: ../links.rst
+
+##########
 CLIP Score
-############################################
+##########
 
 Module Interface
 ________________

diff --git a/docs/source/nominal/cramers_v.rst b/docs/source/nominal/cramers_v.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Nominal
 
+.. include:: ../links.rst
+
 ##########
 Cramer's V
 ##########

diff --git a/docs/source/nominal/fleiss_kappa.rst b/docs/source/nominal/fleiss_kappa.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Nominal
 
+.. include:: ../links.rst
+
 ############
 Fleiss Kappa
 ############

diff --git a/docs/source/nominal/pearsons_contingency_coefficient.rst b/docs/source/nominal/pearsons_contingency_coefficient.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Nominal
 
+.. include:: ../links.rst
+
 #################################
 Pearson's Contingency Coefficient
 #################################

diff --git a/docs/source/nominal/theils_u.rst b/docs/source/nominal/theils_u.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Nominal
 
+.. include:: ../links.rst
+
 #########
 Theil's U
 #########

diff --git a/docs/source/nominal/tschuprows_t.rst b/docs/source/nominal/tschuprows_t.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Nominal
 
+.. include:: ../links.rst
+
 #############
 Tschuprow's T
 #############

diff --git a/docs/source/pairwise/cosine_similarity.rst b/docs/source/pairwise/cosine_similarity.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/translation.svg
    :tags: Pairwise
 
+.. include:: ../links.rst
+
 #################
 Cosine Similarity
 #################

diff --git a/docs/source/pairwise/euclidean_distance.rst b/docs/source/pairwise/euclidean_distance.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/translation.svg
    :tags: Pairwise
 
+.. include:: ../links.rst
+
 ##################
 Euclidean Distance
 ##################

diff --git a/docs/source/pairwise/linear_similarity.rst b/docs/source/pairwise/linear_similarity.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/translation.svg
    :tags: Pairwise
 
+.. include:: ../links.rst
+
 #################
 Linear Similarity
 #################

diff --git a/docs/source/pairwise/manhattan_distance.rst b/docs/source/pairwise/manhattan_distance.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/translation.svg
    :tags: Pairwise
 
+.. include:: ../links.rst
+
 ##################
 Manhattan Distance
 ##################

diff --git a/docs/source/pairwise/minkowski_distance.rst b/docs/source/pairwise/minkowski_distance.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/translation.svg
    :tags: Pairwise
 
+.. include:: ../links.rst
+
 ##################
 Minkowski Distance
 ##################

diff --git a/docs/source/regression/cosine_similarity.rst b/docs/source/regression/cosine_similarity.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Regression
 
+.. include:: ../links.rst
+
 #################
 Cosine Similarity
 #################

diff --git a/docs/source/regression/explained_variance.rst b/docs/source/regression/explained_variance.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Regression
 
+.. include:: ../links.rst
+
 ##################
 Explained Variance
 ##################

diff --git a/docs/source/regression/kl_divergence.rst b/docs/source/regression/kl_divergence.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 #############
 KL Divergence
 #############

diff --git a/docs/source/regression/tweedie_deviance_score.rst b/docs/source/regression/tweedie_deviance_score.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Regression
 
+.. include:: ../links.rst
+
 ######################
 Tweedie Deviance Score
 ######################

diff --git a/docs/source/retrieval/hit_rate.rst b/docs/source/retrieval/hit_rate.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/text_classification.svg
    :tags: Retrieval
 
+.. include:: ../links.rst
+
 ##################
 Retrieval Hit Rate
 ##################