From 648908e700dda2c8272c350a92620cbd85b5b7b5 Mon Sep 17 00:00:00 2001 From: Guillermo Aguilar Date: Tue, 15 Oct 2024 15:45:45 +0200 Subject: [PATCH] docs: adds warning on all pages again with proper syntax, also on generated examples --- docs/examples/demo_001.md | 3 +++ docs/examples/demo_002.md | 3 +++ docs/examples/demo_003.md | 3 +++ docs/examples/demo_004.md | 4 ++++ docs/examples/demo_005.md | 4 ++++ docs/examples/demo_006.md | 4 ++++ docs/examples/parameter_recovery_demo.md | 4 ++++ docs/examples/plot_all_sigmoids.md | 4 ++++ docs/how_to/How-to-Change-the-Threshold-Percent-Correct.rst | 4 ++-- docs/how_to/How-to-Fix-Parameters.rst | 4 ++-- docs/how_to/How-to-Get-Standard-Parameters.rst | 4 ++-- docs/how_to/How-to-Get-Thresholds-and-Slopes.rst | 4 ++-- docs/index.rst | 4 ++-- docs/user_guides/Experiment-Types.rst | 4 ++-- docs/user_guides/Interval-Bias.rst | 2 +- docs/user_guides/Options-Dictionary.rst | 4 ++-- docs/user_guides/Plot-Functions.rst | 4 ++-- docs/user_guides/Pooling-Utility.rst | 4 ++-- docs/user_guides/Priors.rst | 4 ++-- docs/user_guides/Result-Struct.rst | 4 ++-- 20 files changed, 52 insertions(+), 23 deletions(-) diff --git a/docs/examples/demo_001.md b/docs/examples/demo_001.md index 1451b47..65e1ba7 100644 --- a/docs/examples/demo_001.md +++ b/docs/examples/demo_001.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` # 1. Basic Usage diff --git a/docs/examples/demo_002.md b/docs/examples/demo_002.md index 6e9d803..3ea9d4e 100644 --- a/docs/examples/demo_002.md +++ b/docs/examples/demo_002.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` # 2. More Options diff --git a/docs/examples/demo_003.md b/docs/examples/demo_003.md index d79e4f2..d526ba6 100644 --- a/docs/examples/demo_003.md +++ b/docs/examples/demo_003.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` # 3. Result Object diff --git a/docs/examples/demo_004.md b/docs/examples/demo_004.md index 9c35cce..2d2aeea 100644 --- a/docs/examples/demo_004.md +++ b/docs/examples/demo_004.md @@ -11,6 +11,10 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` + # 4. Priors diff --git a/docs/examples/demo_005.md b/docs/examples/demo_005.md index 5dbe14f..f340d0b 100644 --- a/docs/examples/demo_005.md +++ b/docs/examples/demo_005.md @@ -11,6 +11,10 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` + # 5. Plotting diff --git a/docs/examples/demo_006.md b/docs/examples/demo_006.md index fd0966a..7d909bb 100644 --- a/docs/examples/demo_006.md +++ b/docs/examples/demo_006.md @@ -11,6 +11,10 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` + # 6. Additional Functionality diff --git a/docs/examples/parameter_recovery_demo.md b/docs/examples/parameter_recovery_demo.md index 52aea3c..da006b2 100644 --- a/docs/examples/parameter_recovery_demo.md +++ b/docs/examples/parameter_recovery_demo.md @@ -13,6 +13,10 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` + +++ {"nteract": {"transient": {"deleting": false}}} # Parameter Recovery Demo diff --git a/docs/examples/plot_all_sigmoids.md b/docs/examples/plot_all_sigmoids.md index 6419fb7..3a34237 100644 --- a/docs/examples/plot_all_sigmoids.md +++ b/docs/examples/plot_all_sigmoids.md @@ -11,6 +11,10 @@ kernelspec: name: python3 --- +```{warning} +This documentation page is still work in progress! Some information might be outdated. +``` + # Plot Sigmoids diff --git a/docs/how_to/How-to-Change-the-Threshold-Percent-Correct.rst b/docs/how_to/How-to-Change-the-Threshold-Percent-Correct.rst index 6b561f1..b9eb88f 100644 --- a/docs/how_to/How-to-Change-the-Threshold-Percent-Correct.rst +++ b/docs/how_to/How-to-Change-the-Threshold-Percent-Correct.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _how-to-change-threshold-percent-correct: How to: Change the Threshold Percent Correct diff --git a/docs/how_to/How-to-Fix-Parameters.rst b/docs/how_to/How-to-Fix-Parameters.rst index 97d69fd..e7338c6 100644 --- a/docs/how_to/How-to-Fix-Parameters.rst +++ b/docs/how_to/How-to-Fix-Parameters.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _how-to-fix-parameters: How to: Fix Parameters diff --git a/docs/how_to/How-to-Get-Standard-Parameters.rst b/docs/how_to/How-to-Get-Standard-Parameters.rst index 20a8a8c..33c510a 100644 --- a/docs/how_to/How-to-Get-Standard-Parameters.rst +++ b/docs/how_to/How-to-Get-Standard-Parameters.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _how-to-get-standard-parameters: How to: Get Standard Parameters diff --git a/docs/how_to/How-to-Get-Thresholds-and-Slopes.rst b/docs/how_to/How-to-Get-Thresholds-and-Slopes.rst index 07917a6..85ec0d3 100644 --- a/docs/how_to/How-to-Get-Thresholds-and-Slopes.rst +++ b/docs/how_to/How-to-Get-Thresholds-and-Slopes.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _how-to-get-thresholds-and-slopes: How To: Get Thresholds and Slopes diff --git a/docs/index.rst b/docs/index.rst index f55d978..7ab8c24 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -.. WARNING:: - This documentation page is still work in progress! Some information might be outdated. +.. warning:: + Some parts of this documentation are still work in progress! Some information might be outdated. .. psignifit documentation master file diff --git a/docs/user_guides/Experiment-Types.rst b/docs/user_guides/Experiment-Types.rst index 67e8c25..1042539 100644 --- a/docs/user_guides/Experiment-Types.rst +++ b/docs/user_guides/Experiment-Types.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _experiment-types: Experiment Types diff --git a/docs/user_guides/Interval-Bias.rst b/docs/user_guides/Interval-Bias.rst index 79b46c4..879886f 100644 --- a/docs/user_guides/Interval-Bias.rst +++ b/docs/user_guides/Interval-Bias.rst @@ -1,4 +1,4 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. .. _interval-bias: diff --git a/docs/user_guides/Options-Dictionary.rst b/docs/user_guides/Options-Dictionary.rst index fdb847a..94de592 100644 --- a/docs/user_guides/Options-Dictionary.rst +++ b/docs/user_guides/Options-Dictionary.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _options-dictionary: Options Dictionary diff --git a/docs/user_guides/Plot-Functions.rst b/docs/user_guides/Plot-Functions.rst index 3cc08a2..611ab64 100644 --- a/docs/user_guides/Plot-Functions.rst +++ b/docs/user_guides/Plot-Functions.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _plot-functions: Plot Functions diff --git a/docs/user_guides/Pooling-Utility.rst b/docs/user_guides/Pooling-Utility.rst index 47f38c6..e26d699 100644 --- a/docs/user_guides/Pooling-Utility.rst +++ b/docs/user_guides/Pooling-Utility.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _pooling-utility: Pooling Utility diff --git a/docs/user_guides/Priors.rst b/docs/user_guides/Priors.rst index d0a9adb..907dcd2 100644 --- a/docs/user_guides/Priors.rst +++ b/docs/user_guides/Priors.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _priors: Priors diff --git a/docs/user_guides/Result-Struct.rst b/docs/user_guides/Result-Struct.rst index 1dfc181..12e5bb4 100644 --- a/docs/user_guides/Result-Struct.rst +++ b/docs/user_guides/Result-Struct.rst @@ -1,6 +1,6 @@ -.. WARNING:: +.. warning:: This documentation page is still work in progress! Some information might be outdated. - + .. _result-struct: Result Struct