Add MiRS and mimicTPW2_comp readers to sphinx documentation

[joleenf]

Adds the mirs and mimic readers to the index.rst list for documentation.

[djhoese]

Looks like the mimic reader name is wrong. Otherwise, thanks for updating this.

[djhoese]

So it looks like the name is actually mimicTPW2_comp but the python module is mimic_TPW2_nc. We don't need to change it, but this name is ugly. I didn't think we were going to allow uppercase letters in a reader name. Well here we are I guess.

[joleenf]

I will fix it in the index. I can change the uppercase for the reader too, it is up to you. I might be the only one using the mimic reader.

[djhoese]

Maybe change the name in another PR. Let's see what @mraspaud and others think about on slack. What does comp mean by the way?

[joleenf]

comp means that I was just getting started with satpy and did not know what to call it. :) Originally, the reader name matched the name mimicTPW2_comp in the yaml file. I changed the reader name when I reread the documentation, but forgot to change it within the yaml file. FWIW, comp was meant to signal that this is a composite of tpw from the MiRS suite. Someone else mentioned that the sensor and platform names are well named at all and the word product should appear somewhere. This is the opportunity to fix many issues. sensor name, platform name, navigation description and reader name.

[joleenf]

I can pull the mimic information from index.rst until that is resolved, but the MiRS information can remain in the index.rst for the PR.

[djhoese]

Keep both, but just fix the name of the mimic reader in the table so it matches what the reader is actually called (in the YAML, not the python module).

[codecov]

Codecov Report

Merging #1599 (865529d) into master (d881429) will decrease coverage by 0.30%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1599      +/-   ##
==========================================
- Coverage   92.65%   92.34%   -0.31%     
==========================================
  Files         253      254       +1     
  Lines       37174    37388     +214     
==========================================
+ Hits        34442    34527      +85     
- Misses       2732     2861     +129     

Flag	Coverage Δ
behaviourtests	4.78% <ø> (-0.01%)	⬇️
unittests	92.48% <ø> (-0.31%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
satpy/tests/test_resample.py	89.26% <0.00%> (-10.39%)	⬇️
satpy/resample.py	80.34% <0.00%> (-9.16%)	⬇️
satpy/writers/awips_tiled.py	82.32% <0.00%> (-0.64%)	⬇️
satpy/tests/test_data_download.py	100.00% <0.00%> (ø)
satpy/conftest.py	71.42% <0.00%> (ø)
satpy/tests/test_composites.py	99.88% <0.00%> (+<0.01%)	⬆️
satpy/tests/test_scene.py	99.44% <0.00%> (+<0.01%)	⬆️
satpy/composites/__init__.py	88.63% <0.00%> (+0.34%)	⬆️
satpy/tests/reader_tests/test_grib.py	97.79% <0.00%> (+0.38%)	⬆️
satpy/aux_download.py	88.03% <0.00%> (+0.53%)	⬆️
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d881429...865529d. Read the comment docs.

[djhoese]

LGTM