Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document attr and attribute #1310

Closed
wants to merge 1 commit into from
Closed

Document attr and attribute #1310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions documentation/markup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,16 @@ The directives are:
.. attribute:: ham

Description of the attribute.

This directive should be used for defining attributes.::

.. attribute:: my-attr
This attribute `my-attr` should be defined with this directive.

When referring to an attribute, use the ``:attr:`my-attr``` role::

:attr:`my-attr`
Use this role to refer to the attribute `my-attr`

If is also possible to document an attribute outside of a class directive,
for example if the documentation for different attributes and methods is
Expand Down
Loading