Skip to content
Snippets Groups Projects
Commit 637cabee authored by Peter Lünenschloß's avatar Peter Lünenschloß
Browse files

landing page cleaned up

parent 44f2a35b
No related branches found
No related tags found
7 merge requests!685Release 2.4,!684Release 2.4,!567Release 2.2.1,!566Release 2.2,!501Release 2.1,!372fix doctest snippets,!369Current documentation
Pipeline #27281 passed with stages
in 2 minutes and 46 seconds
......@@ -106,6 +106,12 @@ In pycharm one can activate autogeneration of numpy doc style like so:
:py:meth: `saqc.SaQC.show`
```
* The Flags object and/or its content is available via:
```
:py:class: `saqc.Flags`
```
## Linking to function categories
To link to a group of functions, you might generate a rest landing page for that link and add it to
......
......@@ -2,23 +2,15 @@
SaQC documentation
==================
Saqc is a great tool to clean data from rubbish.
.. toctree::
:hidden:
:maxdepth: 1
Repository <https://git.ufz.de/rdm-software/saqc>
Documentation Guide <how_to_doc_md_m2r/HowToDoc>
Package API <moduleAPIs/saqcInit>
Getting Started
===============
.. toctree::
:maxdepth: 2
getting_started_md_m2r/GettingStarted
Tutorials and Topics
====================
......@@ -26,23 +18,36 @@ Tutorials and Topics
.. toctree::
:maxdepth: 1
getting_started_md_m2r/GettingStarted
cook_books_md_m2r/DataRegularisation
cook_books_md_m2r/OutlierDetection
Flagging Functions
==================
Functions
=========
.. toctree::
:maxdepth: 1
:glob:
:titlesonly:
moduleAPIs/saqcFunctions
All Functions <moduleAPIs/saqcFunctions>
generic Functions <function_cats/generic>
regularisation Functions <function_cats/regularisation>
Python Package
==============
.. toctree::
:maxdepth: 2
:glob:
:titlesonly:
SaQC init <moduleAPIs/saqcInit>
:py:mod:`~saqc.constants.BAD`
Indices and tables
==================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment