Skip to content

Commit

Permalink
downgrade Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
mkuznets committed Apr 15, 2024
1 parent 1fe6c86 commit ab7a293
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 36 deletions.
68 changes: 34 additions & 34 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Client-Side
+++++++++++

.. py:class:: pyvk.ClientAuth(app_id=None, username=None, [**options])
:no-index:
:noindex:

Client-side auth object. In this mode a user provides their login/password directly to PyVK.

Expand Down Expand Up @@ -99,19 +99,19 @@ Client-Side
to API objects spawned by :py:meth:`~.ClientAuth.api`.

.. py:attribute:: token
:no-index:
:noindex:

VK API token.
Initialised only if authorisation is complete.

.. py:attribute:: scope
:no-index:
:noindex:

Bitmask of access rights.
Initialised only if authorisation is complete.

.. py:method:: auth()
:no-index:
:noindex:

Starts authorisation.
Initialises :py:attr:`~.ClientAuth.token`
Expand All @@ -120,7 +120,7 @@ Client-Side
:raises AuthError: if authorisation is unsuccessful.

.. py:method:: api([**options])
:no-index:
:noindex:

Returns an :py:class:`~pyvk.API` object if authorised.

Expand Down Expand Up @@ -160,7 +160,7 @@ VK API sends a unique code to the callback URL to complete the authorisation:
.. py:class:: pyvk.ServerAuth(app_id, redirect_uri, [**options])
:no-index:
:noindex:

Server-side auth helper. It is intended for long-running server scripts,
web-services, and other applications where there is no or limited
Expand Down Expand Up @@ -192,23 +192,23 @@ VK API sends a unique code to the callback URL to complete the authorisation:


.. py:attribute:: token
:no-index:
:noindex:

VK API token.
Initialised only if authorisation is complete.

.. py:attribute:: scope
:no-index:
:noindex:

Bitmask of access rights. Ditto.

.. py:attribute:: auth_url
:no-index:
:noindex:

URL for the first step of authorisation

.. py:method:: auth(code, client_secret)
:no-index:
:noindex:

Completes authorisation with `code` and `client_secret` provided by VK
via GET request to `redirect_uri`.
Expand All @@ -220,7 +220,7 @@ VK API sends a unique code to the callback URL to complete the authorisation:
:raises AuthError: if authorisation is unsuccessful.

.. py:method:: api([**options])
:no-index:
:noindex:

Returns an :py:class:`~pyvk.API` object if authorised.

Expand Down Expand Up @@ -279,7 +279,7 @@ There are three ways to get one:
.. py:class:: pyvk.API([token], [**parameters])
:no-index:
:noindex:

:param str token: authorisation token. If `None`, only a small part of
VK API methods is available.)
Expand Down Expand Up @@ -397,7 +397,7 @@ access rights commonly used used in scripts and interactive sessions.
:py:class:`.ServerAuth` defaults to :py:data:`~pyvk.p_offline`.

.. py:data:: pyvk.p_basic
:no-index:
:noindex:

Combines :py:data:`~pyvk.p_friends`,
:py:data:`~pyvk.p_photos`, :py:data:`~pyvk.p_audio`,
Expand All @@ -406,105 +406,105 @@ access rights commonly used used in scripts and interactive sessions.
:py:data:`~pyvk.p_groups`, :py:data:`~pyvk.p_offline`.

.. py:data:: pyvk.p_all
:no-index:
:noindex:

Combines all the access rights.

.. py:data:: pyvk.p_notify
:no-index:
:noindex:

User allowed to send notifications to they (for Flash/iFrame apps)

.. py:data:: pyvk.p_friends
:no-index:
:noindex:

Access to friends.

.. py:data:: pyvk.p_photos
:no-index:
:noindex:

Access to photos.

.. py:data:: pyvk.p_audio
:no-index:
:noindex:

Access to audio.

.. py:data:: pyvk.p_video
:no-index:
:noindex:

Access to video.

.. py:data:: pyvk.p_pages
:no-index:
:noindex:

Access to wiki pages.

.. py:data:: pyvk.p_leftmenu
:no-index:
:noindex:

Addition of link to the application in the left menu.

.. py:data:: pyvk.p_status
:no-index:
:noindex:

Access to user status.

.. py:data:: pyvk.p_notes
:no-index:
:noindex:

Access to notes.

.. py:data:: pyvk.p_messages
:no-index:
:noindex:

Access to advanced methods for messaging.
Unavailable for server-side authorisation.

.. py:data:: pyvk.p_wall
:no-index:
:noindex:

Access to standard and advanced methods for the wall.
Ignored for server-side authorisation.

.. py:data:: pyvk.p_ads
:no-index:
:noindex:

Access to advanced methods for `Ads API <https://vk.com/dev/ads>`__.

.. py:data:: pyvk.p_offline
:no-index:
:noindex:

Access to API at any time (non-expiring access token).

.. py:data:: pyvk.p_docs
:no-index:
:noindex:

Access to docs.

.. py:data:: pyvk.p_groups
:no-index:
:noindex:

Access to user communities.

.. py:data:: pyvk.p_notifications
:no-index:
:noindex:

Access to notifications about answers to the user.

.. py:data:: pyvk.p_stats
:no-index:
:noindex:

Access to statistics of user groups and applications
where they is an administrator.

.. py:data:: pyvk.p_email
:no-index:
:noindex:

Access to user email.

.. py:data:: pyvk.p_market
:no-index:
:noindex:

Access to market.

Expand All @@ -514,7 +514,7 @@ User Input
++++++++++

.. autoclass:: pyvk.Input
:no-index:
:noindex:
:members:

Options
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ dev-dependencies = [
"pytest==8.1.1",
"pytest-cov==5.0.0",
"coverage<7.0",
"sphinx==7.2.6",
"sphinx==7.1.2",
"alabaster==0.7.13",
"coveralls>=3.3.1",
]
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.lock
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ requests==2.31.0
# via sphinx
snowballstemmer==2.2.0
# via sphinx
sphinx==7.2.6
sphinx==7.1.2
sphinxcontrib-applehelp==1.0.8
# via sphinx
sphinxcontrib-devhelp==1.0.6
Expand Down

0 comments on commit ab7a293

Please sign in to comment.