Skip to content

Commit

Permalink
Document inherited attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
Dmitrii-I committed Jan 30, 2019
1 parent 54073f3 commit f8cdec9
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,29 @@ Features
=============================

.. automodule:: sportmonks.soccer
:members:
:inherited-members:
:undoc-members:

.. autoclass:: SoccerApiV2
:members:
:inherited-members:
:undoc-members:
:show-inheritance:

.. Inherited instance variables are not documented by autodoc.
Bug: https://github.com/sphinx-doc/sphinx/issues/741. Therefore we have to document them manually.
.. attribute:: http_requests_made

Number of HTTP requests made.

.. attribute:: base_url

Base URL of the endpoint the client connects to.

.. attribute:: api_token

API token the client uses to authenticate with SportMonks.com servers.

.. attribute:: tz_name

Name of the timezone the returned datetimes will have.

0 comments on commit f8cdec9

Please sign in to comment.