interpd def plot ( self, * args, ** kwargs ): """ Some stuff omitted Other Parameters - scalex, scaley : bool, default: True These parameters determine if the view limits are adapted to the data limits. Use array instead ofĪrray-like for return types if the returned object is indeed a numpy array.įloat is the implicit default dtype for array-likes. Read and no special formatting is needed. When referring to them in the text they are easier Sizes of the dimensions, use capital letters in brackets If you need to have variables denoting the Dimensionality may be specified using 2D,ģD, n-dimensional. Use array-like for homogeneous numeric sequences, which could Included to make the tuple-ness more obvious. Use (float, float) to describe a 2D position. Use float for a type that can be any number. Rules expand on them where the numpydoc conventions are not specific. Generally, the numpydoc docstring guide conventions apply. Simplification for the type description and explain the type more If the possible types are too complex use a ![]() The main goal for parameter type descriptions is to be readable and Slightly improve the rendered docs, they are cumbersome to type and difficult The use of extra literal quotes around the text is discouraged. If 'tight', try to figure out the tight bbox of the figure. The quotes for single line docstrings are on the same line (pydocstyle D200): Some Matplotlib-specific formatting conventions The basic docstring conventions are covered in the numpydoc docstring guideĪnd the Sphinx documentation. Markup and working with Sphinx in general. The Sphinx website also contains plenty of documentation concerning ReST See the hlines documentation for how this renders. See Also - vlines : vertical lines axhline : horizontal line across the Axes """ colors : list of colors, default: :rc:`lor` linestyles :, optional label : str, default: '' Returns - `~` Other Parameters - data : indexable object, optional DATA_PARAMETER_PLACEHOLDER **kwargs : `~` properties. If scalars are provided, all lines will have the same length. xmin, xmax : float or array-like Respective beginning and end of each line. Parameters - y : float or array-like y-indexes where to plot the lines. This will keep Matplotlib's documentation consistentĭef hlines ( self, y, xmin, xmax, colors = None, linestyles = 'solid', label = '', ** kwargs ): """ Plot horizontal lines at each *y* from *xmin* to *xmax*. Function arguments #įunction arguments and keywords within docstrings should be referred to using This may not yet be applied consistently in existing docs. All other pages should start with "chapter" or lower. We aim to follow the recommendations from theĪnd the Sphinx reStructuredText documentation ![]() Use sentence case Upper lower for section titles, e.g., Possible hangups rather than HereĪre some formatting and style conventions that are used. It is useful to strive for consistency in the Matplotlib documentation. This section contains additional information and conventions how ReST is used The reStructuredText reference documentation. More complete information is available in rst files, or in examples and tutorials.Īll of these use the ReST syntax and are processed by Sphinx.Ī good introduction into using ReST. Most documentation is either in the docstrings of individualĬlasses and methods, in explicit. rst file rather than a gallery or tutorial example, choose anĪppropriate subdirectory to put it in, and add the file to the table ofĬontents of index.rst of the subdirectory. If you would like to add new documentation that is suited Third, Matplotlib has narrative docs written in ReST in subdirectories ofĭoc/users/. To *.rst files with the result of Matplotlib plot calls as embedded images. Sphinx Gallery converts example Python files Second, our example pages, tutorials, and some of the narrative documentationĪre created by Sphinx Gallery. The docstrings of the classes in the Matplotlib library. rst) files that are rendered to documentation pages.ĭocumentation is created in three ways. The doc/ĭirectory contains configuration files for Sphinx and reStructuredText Write documentation # Getting started # General file structure #Īll documentation is built from the doc/.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |