File: changeset.rst

package info (click to toggle)
sphinx-toolbox 3.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,924 kB
  • sloc: python: 11,636; sh: 26; javascript: 25; makefile: 16
file content (48 lines) | stat: -rw-r--r-- 1,072 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
=================================
:mod:`~sphinx_toolbox.changeset`
=================================

.. automodule:: sphinx_toolbox.changeset
	:member-order: bysource
	:no-autosummary:
	:exclude-members: run


Examples
---------------

.. rest-example::

	.. versionadded:: 2.4
	.. versionadded:: 2.5  The *spam* parameter.

	.. versionadded:: 2.6
		The *parrot* parameter.

.. rest-example::

	.. deprecated:: 3.1
		Use :func:`spam` instead.

	.. deprecated:: 3.2  Use :func:`lobster` instead.

.. rest-example::

	.. versionremoved:: 1.2.3  Use :func:`foo` instead.

	.. versionremoved:: 1.2.3

		Due to an unfixable bug this function has been removed.
		If you desperately need this functionality please write to the mailing list at
		:email:`python-users@example.org`

.. only:: html

	.. rest-example::

		.. versionchanged:: 0.3.0

			* Parameters for ``__init__`` can be documented either in the class docstring
			  or alongside the attribute.
			  The class docstring has priority.
			* Added support for `autodocsumm <https://github.com/Chilipp/autodocsumm>`_.