rename arviz-doc to arviz-docgrid and make arviz-doc a non-grid style #2157
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2157 +/- ##
=======================================
Coverage 90.70% 90.70%
=======================================
Files 120 120
Lines 12647 12647
=======================================
Hits 11471 11471
Misses 1176 1176 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
cc @sarinac |
There was a problem hiding this comment.
Thanks @aloctavodia for adding!
A few questions:
- I made comments on keeping the doc/docgrid styles exactly the same except for
axes.grid=True. LMK if any concerns. - Can you add the new
arviz-docgridtodoc/examples/matplotlib/mpl_styles.py? That way users can discover it. - This will remove grids for all charts generated throughout the entire documentation (homepage, example gallery, api documentation examples). Should we vary a few, change everything to
arviz-docgrid, or leave things the way they are with the newarviz-doc(nothing will have grids)? My opinion is that there are some charts (e.g. violin) that look better with axes, but stuff like posterior plot (too cluttered in the examples right now) look better without.
| # axes.grid.axis: y # which axis the grid should apply to | ||
| axes.grid.which: major # grid lines at {major, minor, both} ticks |
There was a problem hiding this comment.
Can we keep this? Without explicitly setting axes.grid.which to "major", the axis will show both major and minor. I like things more simple and less clutterry, which is what I was hoping this style goes for.
I think the only differentiator between arviz-doc and arviz-docgrid is the presence of the grid. Even with arviz-doc style applied, you can override the grid visibility by applying plt.grid(). If the user happens to do that, then I want it to match arviz-docgrid's style to a tee.
| grid.color: .8 # grid color | ||
| grid.linestyle: - # solid | ||
| grid.linewidth: 0.8 # in points | ||
| grid.alpha: 1.0 # transparency, between 0.0 and 1.0 | ||
|
|
There was a problem hiding this comment.
Can we keep these too for the same reason above?
|
thanks for the comments @sarinac. I updated the styles |
📚 Documentation preview 📚: https://arviz--2157.org.readthedocs.build/en/2157/