iris-grib
iris-grib copied to clipboard
SciTools
Align to SciTools documentation standard
Align the Sphinx documentation look'n feel, configuration and building to that of iris.
See https://github.com/SciTools/iris/pull/3752
After quite a wait on this, we still don't seem to have a consistent Scitools style. Think we can close for now @pp-mo @trexfeathers
@pp-mo I think this is still applicable.
To make it more concrete, the target is to adopt documentation patterns and infrastructure akin to SciTools/iris
Perhaps @tkknight has a list of top-level features that he'd like to see adopted and prioritised, given that he's been curating the documentation over on SciTools/iris ?
@pp-mo I think this is still applicable.
To make it more concrete, the target is to adopt documentation patterns and infrastructure akin to SciTools/iris
Perhaps @tkknight has a list of top-level features that he'd like to see adopted and prioritised, given that he's been curating the documentation over on SciTools/iris ?
This is an 80/20 thing for me. Iris-grib has informative documentation that is rendered automatically, and its depth feels proportional to the resource we have available for this package. I am absolutely sure @bjlittle is right that the documentation could be even better if we put more effort into it, but I personally don't consider the extra benefit to be worth the extra effort. I would rather spend that effort addressing user requests/bugs.
@trexfeathers Agreed. But this still needs done, right?
And this issue is a simple reminder of that. When we choose to do it and what it involves is another matter, but I don't agree with closing this issue and that's why I reopened it 👍
I think there is a need to ensure some best practice around how we do and present any SciTools documentation.
@pp-mo and I chat about this off line.
