diff --git a/docs/cookbooks/CookBooksPanels.rst b/docs/cookbooks/CookBooksPanels.rst index 7f3d11550746d20beb38240d69e97dcd157085e6..a852b237f492e98bd1329b6506d9b787ff54a8ad 100644 --- a/docs/cookbooks/CookBooksPanels.rst +++ b/docs/cookbooks/CookBooksPanels.rst @@ -7,6 +7,17 @@ Cook Books ========== +.. toctree:: + :caption: Cookbooks + :maxdepth: 1 + :hidden: + + DataRegularisation + OutlierDetection + ResidualOutlierDetection + MultivariateFlagging + ../documentation/GenericFunctions + .. grid:: 2 :gutter: 2 diff --git a/docs/devresources/devResPanels.rst b/docs/devresources/devResPanels.rst index 26958008f2630a3b5ed267591c1213131026fd51..77db10a7b9bdee170ab0969cbcd341926c50f156 100644 --- a/docs/devresources/devResPanels.rst +++ b/docs/devresources/devResPanels.rst @@ -5,6 +5,13 @@ Developers Resources ==================== +.. toctree:: + :caption: Developer Resources + :hidden: + :maxdepth: 1 + + Documentation Guide <HowToDoc> + Writing Functions <WritingFunctions> .. grid:: 3 :gutter: 2 diff --git a/docs/documentation/documentationPanels.rst b/docs/documentation/documentationPanels.rst index b2d61129363a4bde1f766adcc47d360a2d1169c5..ea1313a7c09300ab3287fe1ebd0c1dc7113505cd 100644 --- a/docs/documentation/documentationPanels.rst +++ b/docs/documentation/documentationPanels.rst @@ -7,6 +7,17 @@ Documentation ============= +.. toctree:: + :caption: Documentation + :maxdepth: 1 + :hidden: + + ConfigurationFiles + GlobalKeywords + Customizations + SourceTarget + FlaggingTranslation + .. grid:: 3 :gutter: 2 diff --git a/docs/funcs/funcsPanels.rst b/docs/funcs/funcsPanels.rst index e38177ecda6b9365535e81b3cce68dae3ed35ae6..103f3c26a0523fc2e9d5ce6cd0bf3449eda663d8 100644 --- a/docs/funcs/funcsPanels.rst +++ b/docs/funcs/funcsPanels.rst @@ -4,6 +4,7 @@ .. _funcs: + Anomaly Detection ------------------ @@ -69,7 +70,7 @@ Data and Flags Tools * copy and delete variables +++ - .. grid-item-card:: generic and custom function wrapper + .. grid-item-card:: Generic and Custom Functions :link: genericWrapper :link-type: doc @@ -86,7 +87,7 @@ Data Manipulation .. grid:: 2 :gutter: 2 - .. grid-item-card:: Data products + .. grid-item-card:: Data Products :link: dataProducts :link-type: doc diff --git a/docs/gettingstarted/GettingStartedPanels.rst b/docs/gettingstarted/GettingStartedPanels.rst index d430058fe3ed33ae9cbbdfa700b5e3a9332d4d0d..e5c8b85aac7df54f4abc212efa5d31346d9cbecf 100644 --- a/docs/gettingstarted/GettingStartedPanels.rst +++ b/docs/gettingstarted/GettingStartedPanels.rst @@ -7,6 +7,15 @@ Getting Started =============== +.. toctree:: + :caption: Getting started + :maxdepth: 1 + :titlesonly: + :hidden: + + InstallationGuide + TutorialAPI + TutorialCLI .. grid:: 3 :gutter: 2 diff --git a/docs/index.rst b/docs/index.rst index 6f702d2951139508e7cdbf80eea81357af8d54ea..af871c7771817f7676f33a6d9d2e60ac8cd27fa5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,78 +6,23 @@ .. toctree:: - :hidden: - :maxdepth: 1 - - Repository <https://git.ufz.de/rdm-software/saqc> - - -.. toctree:: - :caption: Getting started - :maxdepth: 1 - :hidden: - - gettingstarted/GettingStartedPanels - gettingstarted/InstallationGuide - gettingstarted/TutorialAPI - gettingstarted/TutorialCLI - - -.. toctree:: - :caption: Cookbooks - :maxdepth: 1 - :hidden: - - cookbooks/CookBooksPanels - cookbooks/DataRegularisation - cookbooks/OutlierDetection - cookbooks/ResidualOutlierDetection - cookbooks/MultivariateFlagging - -.. toctree:: - :caption: Documentation :maxdepth: 1 + :titlesonly: :hidden: - documentation/documentationPanels - documentation/ConfigurationFiles - documentation/GenericFunctions - documentation/GlobalKeywords - documentation/Customizations - documentation/SourceTarget - documentation/FlaggingTranslation - -.. - .. toctree:: - :caption: Functions - :hidden: - :maxdepth: 1 - :glob: - :titlesonly: - - resampling <funcs/resampling> - generic <funcs/generic> - outliers <funcs/outliers> - breaks <funcs/breaks> - constants <funcs/constants> - changepoints <funcs/changepoints> - drift <funcs/drift> - curvefit <funcs/curvefit> - interpolation <funcs/interpolation> - residuals <funcs/residuals> - tools <funcs/tools> - flagtools <funcs/flagtools> - rolling <funcs/rolling> - scores <funcs/scores> - transformation <funcs/transformation> - noise <funcs/noise> - pattern <funcs/pattern> + Repository <https://git.ufz.de/rdm-software/saqc> + Getting Started <gettingstarted/GettingStartedPanels> + Guides <cookbooks/CookBooksPanels> + Configurator <https://webapp.ufz.de/saqc-config-app/> + Documentation <documentation/documentationPanels> + Functions API <funcs/funcsPanels> + Developer Resources <devresources/devResPanels> .. toctree:: :caption: SaQC :hidden: - :maxdepth: 2 + :maxdepth: 1 Package <modules/SaQC> Core <modules/SaQCCore> @@ -85,15 +30,6 @@ Translations <modules/SaQCTranslation> Constants <modules/SaQCConstants> -.. toctree:: - :caption: Developer Resources - :hidden: - :maxdepth: 1 - - devresources/devResPanels - Documentation Guide <devresources/HowToDoc> - Writing Functions <devresources/WritingFunctions> - .. Indices and tables diff --git a/docs/misc/title.rst b/docs/misc/title.rst index 0ff98e1266c24f0b2c27204aea0f461637aa6b68..7bfc81830ac53a6668d2701aff516d3bd09eb4d2 100644 --- a/docs/misc/title.rst +++ b/docs/misc/title.rst @@ -67,6 +67,7 @@ Documentation +++ *Step-by-step guides to the implementation of basic QC tasks in SaQC* + .. grid-item-card:: Documentations :link: ../documentation/documentationPanels :link-type: doc @@ -78,8 +79,6 @@ Documentation *Introductions to core mechanics and principles* - - .. grid-item-card:: Developer Resources :link: ../devresources/devResPanels :link-type: doc