fix: build docs in docs/source like in readthedoc server

sktime · Mar 11, 2024 · f374c98 · f374c98
1 parent 32fed8b
commit f374c98
Show file tree

Hide file tree

Showing 55 changed files with 429 additions and 64 deletions.
diff --git a/.gitignore b/.gitignore
@@ -77,9 +77,8 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs/build/
 docs/source/api_reference/auto_generated/
-docs/estimator_overview_table.md
 
 # PyBuilder
 target/

diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/Makefile → docs/source/Makefile b/docs/Makefile → docs/source/Makefile
@@ -2,13 +2,14 @@
 
 # You can set these variables from the command line.
 PREPROCESS    = sphinx-apidoc
-APIDOCTEMPLATEDIR = source/_templates/apidoc
-AUTOGENDIR    = source/api_reference/auto_generated
+APIDOCTEMPLATEDIR = _templates/apidoc
+AUTOGENDIR    = api_reference/auto_generated
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = _build
-PROJECTDIR    = "../sktime/"
+SPHINXAUTOBUILD   = sphinx-autobuild
+SOURCEDIR     = ./
+BUILDDIR      = ../build
+PROJECTDIR    = "../../sktime/"
 
 # exclude unit tests from API reference
 EXCLUDEPATHS = "../*tests* ../*test* ../*contrib* ../*setup* ../*all*"

diff --git a/docs/source/estimator_overview_table.md b/docs/source/estimator_overview_table.md
diff --git a/docs/source/examples/00_sktime_intro.ipynb b/docs/source/examples/00_sktime_intro.ipynb
@@ -0,0 +1 @@
+../../../examples/00_sktime_intro.ipynb
diff --git a/docs/source/examples/01c_forecasting_hierarchical_global.ipynb b/docs/source/examples/01c_forecasting_hierarchical_global.ipynb
@@ -0,0 +1 @@
+../../../examples/01c_forecasting_hierarchical_global.ipynb
diff --git a/docs/source/examples/02a_classification_multivariate_cnn.ipynb b/docs/source/examples/02a_classification_multivariate_cnn.ipynb
@@ -0,0 +1 @@
+../../../examples/02a_classification_multivariate_cnn.ipynb
diff --git a/docs/source/examples/02b_classification_multivariate_lstmfcn.ipynb b/docs/source/examples/02b_classification_multivariate_lstmfcn.ipynb
@@ -0,0 +1 @@
+../../../examples/02b_classification_multivariate_lstmfcn.ipynb
diff --git a/docs/source/examples/02c_classification_multivariate_inceptiontime.ipynb b/docs/source/examples/02c_classification_multivariate_inceptiontime.ipynb
@@ -0,0 +1 @@
+../../../examples/02c_classification_multivariate_inceptiontime.ipynb
diff --git a/docs/source/examples/03_transformers.ipynb b/docs/source/examples/03_transformers.ipynb
@@ -0,0 +1 @@
+../../../examples/03_transformers.ipynb
diff --git a/docs/source/examples/03a_transformers_cheat_sheet.ipynb b/docs/source/examples/03a_transformers_cheat_sheet.ipynb
@@ -0,0 +1 @@
+../../../examples/03a_transformers_cheat_sheet.ipynb
diff --git a/docs/source/examples/03b_forecasting_transformers_pipelines_tuning.ipynb b/docs/source/examples/03b_forecasting_transformers_pipelines_tuning.ipynb
@@ -0,0 +1 @@
+../../../examples/03b_forecasting_transformers_pipelines_tuning.ipynb
diff --git a/docs/source/examples/04_benchmarking_v2.ipynb b/docs/source/examples/04_benchmarking_v2.ipynb
@@ -0,0 +1 @@
+../../../examples/04_benchmarking_v2.ipynb
diff --git a/docs/source/examples/annotation/segmentation_with_clasp.ipynb b/docs/source/examples/annotation/segmentation_with_clasp.ipynb
diff --git a/docs/source/examples/blog_posts b/docs/source/examples/blog_posts
@@ -0,0 +1 @@
+../../../examples/blog_posts
diff --git a/docs/source/examples/catch22.ipynb b/docs/source/examples/catch22.ipynb
@@ -0,0 +1 @@
+../../../examples/catch22.ipynb
diff --git a/docs/source/examples/channel_selection.ipynb b/docs/source/examples/channel_selection.ipynb
@@ -0,0 +1 @@
+../../../examples/channel_selection.ipynb
diff --git a/docs/source/examples/classification/02a_classification_multivariate_cnn.ipynb b/docs/source/examples/classification/02a_classification_multivariate_cnn.ipynb
diff --git a/docs/source/examples/classification/channel_selection.ipynb b/docs/source/examples/classification/channel_selection.ipynb
diff --git a/docs/source/examples/classification/dictionary_based_classification.ipynb b/docs/source/examples/classification/dictionary_based_classification.ipynb
diff --git a/docs/source/examples/classification/early_classification.ipynb b/docs/source/examples/classification/early_classification.ipynb
diff --git a/docs/source/examples/classification/interval_based_classification.ipynb b/docs/source/examples/classification/interval_based_classification.ipynb
diff --git a/docs/source/examples/clustering/partition_based_clustering.ipynb b/docs/source/examples/clustering/partition_based_clustering.ipynb
diff --git a/docs/source/examples/data/loading_data.ipynb b/docs/source/examples/data/loading_data.ipynb
diff --git a/docs/source/examples/dictionary_based_classification.ipynb b/docs/source/examples/dictionary_based_classification.ipynb
@@ -0,0 +1 @@
+../../../examples/dictionary_based_classification.ipynb
diff --git a/docs/source/examples/distances.ipynb b/docs/source/examples/distances.ipynb
@@ -0,0 +1 @@
+../../../examples/distances.ipynb
diff --git a/docs/source/examples/early_classification.ipynb b/docs/source/examples/early_classification.ipynb
@@ -0,0 +1 @@
+../../../examples/early_classification.ipynb
diff --git a/docs/source/examples/feature_extraction_with_tsfresh.ipynb b/docs/source/examples/feature_extraction_with_tsfresh.ipynb
@@ -0,0 +1 @@
+../../../examples/feature_extraction_with_tsfresh.ipynb
diff --git a/docs/source/examples/forecasting/01c_forecasting_hierarchical_global.ipynb b/docs/source/examples/forecasting/01c_forecasting_hierarchical_global.ipynb
diff --git a/docs/source/examples/forecasting/window_splitters.ipynb b/docs/source/examples/forecasting/window_splitters.ipynb
diff --git a/docs/source/examples/global_fc b/docs/source/examples/global_fc
@@ -0,0 +1 @@
+../../../examples/global_fc
diff --git a/docs/source/examples/hidalgo_segmentation.ipynb b/docs/source/examples/hidalgo_segmentation.ipynb
@@ -0,0 +1 @@
+../../../examples/hidalgo_segmentation.ipynb
diff --git a/docs/source/examples/interpolation.ipynb b/docs/source/examples/interpolation.ipynb
@@ -0,0 +1 @@
+../../../examples/interpolation.ipynb
diff --git a/docs/source/examples/interval_based_classification.ipynb b/docs/source/examples/interval_based_classification.ipynb
@@ -0,0 +1 @@
+../../../examples/interval_based_classification.ipynb
diff --git a/docs/source/examples/loading_data.ipynb b/docs/source/examples/loading_data.ipynb
@@ -0,0 +1 @@
+../../../examples/loading_data.ipynb
diff --git a/docs/source/examples/minirocket.ipynb b/docs/source/examples/minirocket.ipynb
@@ -0,0 +1 @@
+../../../examples/minirocket.ipynb
diff --git a/docs/source/examples/mlflow.ipynb b/docs/source/examples/mlflow.ipynb
@@ -0,0 +1 @@
+../../../examples/mlflow.ipynb
diff --git a/docs/source/examples/other/distances.ipynb b/docs/source/examples/other/distances.ipynb
diff --git a/docs/source/examples/partition_based_clustering.ipynb b/docs/source/examples/partition_based_clustering.ipynb
@@ -0,0 +1 @@
+../../../examples/partition_based_clustering.ipynb
diff --git a/docs/source/examples/plateau_finder.ipynb b/docs/source/examples/plateau_finder.ipynb
@@ -0,0 +1 @@
+../../../examples/plateau_finder.ipynb
diff --git a/docs/source/examples/rocket.ipynb b/docs/source/examples/rocket.ipynb
@@ -0,0 +1 @@
+../../../examples/rocket.ipynb
diff --git a/docs/source/examples/segmentation_with_clasp.ipynb b/docs/source/examples/segmentation_with_clasp.ipynb
@@ -0,0 +1 @@
+../../../examples/segmentation_with_clasp.ipynb
diff --git a/docs/source/examples/signature_method.ipynb b/docs/source/examples/signature_method.ipynb
@@ -0,0 +1 @@
+../../../examples/signature_method.ipynb
diff --git a/docs/source/examples/theta_transform.ipynb b/docs/source/examples/theta_transform.ipynb
@@ -0,0 +1 @@
+../../../examples/theta_transform.ipynb
diff --git a/docs/source/examples/transformation/catch22.ipynb b/docs/source/examples/transformation/catch22.ipynb
diff --git a/docs/source/examples/transformation/feature_extraction_with_tsfresh.ipynb b/docs/source/examples/transformation/feature_extraction_with_tsfresh.ipynb
diff --git a/docs/source/examples/transformation/hidalgo_segmentation.ipynb b/docs/source/examples/transformation/hidalgo_segmentation.ipynb
diff --git a/docs/source/examples/transformation/interpolation.ipynb b/docs/source/examples/transformation/interpolation.ipynb
diff --git a/docs/source/examples/transformation/minirocket.ipynb b/docs/source/examples/transformation/minirocket.ipynb
diff --git a/docs/source/examples/transformation/plateau_finder.ipynb b/docs/source/examples/transformation/plateau_finder.ipynb
diff --git a/docs/source/examples/transformation/rocket.ipynb b/docs/source/examples/transformation/rocket.ipynb
diff --git a/docs/source/examples/transformation/signature_method.ipynb b/docs/source/examples/transformation/signature_method.ipynb
diff --git a/docs/source/examples/transformation/theta_transform.ipynb b/docs/source/examples/transformation/theta_transform.ipynb
diff --git a/docs/source/examples/window_splitters.ipynb b/docs/source/examples/window_splitters.ipynb
@@ -0,0 +1 @@
+../../../examples/window_splitters.ipynb
diff --git a/docs/symlink_examples.sh → docs/source/symlink_examples.sh b/docs/symlink_examples.sh → docs/source/symlink_examples.sh
@@ -4,10 +4,10 @@
 # notebooks in example folder
 
 # remove all
-rm -rf source/examples/*
+rm -rf examples/*
 
 # cd into website folder
-cd source/examples/ || return
+cd examples/ || return
 
 # create symbolic links in website folder
 ln -s ../../../examples/* .