diff --git a/docs/building/filters.rst b/docs/building/filters.rst index 2f652a81..f26467e6 100644 --- a/docs/building/filters.rst +++ b/docs/building/filters.rst @@ -4,22 +4,19 @@ Filters ######### -Filters are used to modify the data or metadata in a dataset. - -******** - select -******** +.. warning:: -.. include:: filters/select.rst + This is still a work in progress. Some of the filters may be renamed + later. -******** - rename -******** - -.. include:: filters/rename.rst +Filters are used to modify the data or metadata in a dataset. -************** - rotate_winds -************** +.. toctree:: + :maxdepth: 1 -.. include:: filters/rotate_winds.rst + filters/select + filters/rename + filters/rotate_winds + filters/unrotate_winds + filters/noop + filters/empty diff --git a/docs/building/filters/rename.rst b/docs/building/filters/rename.rst index 1333ed77..cfb184a6 100644 --- a/docs/building/filters/rename.rst +++ b/docs/building/filters/rename.rst @@ -1 +1,3 @@ -TODO +######## + rename +######## diff --git a/docs/building/filters/rotate_winds.rst b/docs/building/filters/rotate_winds.rst index 1333ed77..e2832de3 100644 --- a/docs/building/filters/rotate_winds.rst +++ b/docs/building/filters/rotate_winds.rst @@ -1 +1,3 @@ -TODO +############## + rotate_winds +############## diff --git a/docs/building/filters/select.rst b/docs/building/filters/select.rst index 1333ed77..7fdd5c63 100644 --- a/docs/building/filters/select.rst +++ b/docs/building/filters/select.rst @@ -1 +1,3 @@ -TODO +######## + select +######## diff --git a/docs/building/sources.rst b/docs/building/sources.rst index bba2512f..5ebab3b6 100644 --- a/docs/building/sources.rst +++ b/docs/building/sources.rst @@ -4,40 +4,13 @@ Sources ######### -****** - mars -****** +The following `sources` are currently available: -.. include:: sources/mars.rst +.. toctree:: + :maxdepth: 1 -****** - grib -****** - -.. include:: sources/grib.rst - -******** - netcdf -******** - -.. include:: sources/netcdf.rst - -********* - opendap -********* - -.. include:: sources/opendap.rst - -*************** - accumulations -*************** - -.. include:: sources/accumulations.rst - -.. _forcing_variables: - -*********** - constants -*********** - -.. include:: sources/constants.rst + sources/mars + sources/grib + sources/netcdf + sources/opendap + sources/constants diff --git a/docs/building/sources/accumulations.rst b/docs/building/sources/accumulations.rst index 1333ed77..37541d0f 100644 --- a/docs/building/sources/accumulations.rst +++ b/docs/building/sources/accumulations.rst @@ -1 +1,3 @@ -TODO +############### + accumulations +############### diff --git a/docs/building/sources/constants.rst b/docs/building/sources/constants.rst index 1333ed77..c62d638b 100644 --- a/docs/building/sources/constants.rst +++ b/docs/building/sources/constants.rst @@ -1 +1,5 @@ -TODO +.. _forcing_variables: + +########### + constants +########### diff --git a/docs/building/sources/grib.rst b/docs/building/sources/grib.rst index 1333ed77..d74e618a 100644 --- a/docs/building/sources/grib.rst +++ b/docs/building/sources/grib.rst @@ -1 +1,3 @@ -TODO +###### + grib +###### diff --git a/docs/building/sources/mars.rst b/docs/building/sources/mars.rst index ec1f3a07..b72cee26 100644 --- a/docs/building/sources/mars.rst +++ b/docs/building/sources/mars.rst @@ -1,3 +1,7 @@ +###### + mars +###### + The ``mars`` source will retrieve the data from the ECMWF MARS archive. For that, you need to have an ECMWF account and build your dataset on one of the Centre's computers, or use the ``ecmwfapi`` Python package. diff --git a/docs/building/sources/netcdf.rst b/docs/building/sources/netcdf.rst index 1333ed77..2158f195 100644 --- a/docs/building/sources/netcdf.rst +++ b/docs/building/sources/netcdf.rst @@ -1 +1,3 @@ -TODO +######## + netcdf +######## diff --git a/docs/building/sources/opendap.rst b/docs/building/sources/opendap.rst index 1333ed77..e6c74d99 100644 --- a/docs/building/sources/opendap.rst +++ b/docs/building/sources/opendap.rst @@ -1 +1,3 @@ -TODO +######### + opendap +#########