Hi all, A while back, Mike drafted a MEP to modernize the documentation:
https://github.com/matplotlib/matplotlib/wiki/Mep10 The main idea behind this MEP is to use the full potential of new tools and conventions available for sphinx, to make the documentation more readable, maintainable and consistent over the codebase. The main proposed changes are the following: - follow the numpy docstring format, which is widely adopted among scientific python projects (numpy, scipy, scikit-learn, scikit-image, etc). - use the autodoc_docstring_signature of sphinx 1.1, which allow to have the explicit function signature instead of the python one in the generated documentation (args* and **kwargs are replaced by the explicits arguments) - replace the duplication of the documentation (by concatenating docstrings) by explicits references. This will shorten the docstrings. - use the autosummary extension of sphinx (sphinx aggregates small classes on one page, while classes with many methods such as Axes.axes have one page dedicated to them) - examples should link to relevant documentation The implementation is going to be long and tedious: Mike has separated it 5 steps, that can be done independently from one another. If this MEP has been accepted, I can start implementing it (with step 1). Thanks, N
------------------------------------------------------------------------------ Master Java SE, Java EE, Eclipse, Spring, Hibernate, JavaScript, jQuery and much more. Keep your Java skills current with LearnJavaNow - 200+ hours of step-by-step video tutorials by Java experts. SALE $49.99 this month only -- learn more at: http://p.sf.net/sfu/learnmore_122612
_______________________________________________ Matplotlib-devel mailing list Matplotlib-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/matplotlib-devel
