Browse Source

Add subheadlines for the model docs

master
parent
commit
029286209a
No known key found for this signature in database GPG Key ID: DA34C790D267C164
2 changed files with 22 additions and 10 deletions
  1. +21
    -9
      docs/models.rst
  2. +1
    -1
      tildee/__init__.py

+ 21
- 9
docs/models.rst View File

@ -3,18 +3,15 @@ Model Classes
These are all representations of "things" on Tildes, created from HTML from the site and provide easy access to the interesting parts of that HTML.
Topics
------
.. autoclass:: tildee.models.TildesTopic
:members:
.. autoclass:: tildee.models.TildesPartialTopic
:members:
.. autoclass:: tildee.models.TildesGroup
:members:
.. autoclass:: tildee.models.TildesComment
:members:
.. autoclass:: tildee.models.TildesTopicLogEntry
:members:
@ -24,6 +21,12 @@ These are all representations of "things" on Tildes, created from HTML from the
.. autoclass:: tildee.models.TildesAccessStatus
:members:
Comments
--------
.. autoclass:: tildee.models.TildesComment
:members:
.. autoclass:: tildee.models.TildesNotification
:members:
@ -31,11 +34,20 @@ These are all representations of "things" on Tildes, created from HTML from the
:members:
:undoc-members:
.. autoclass:: tildee.models.TildesConversation
Groups
------
.. autoclass:: tildee.models.TildesGroup
:members:
.. autoclass:: tildee.models.TildesWikiPage
:members:
.. autoclass:: tildee.models.TildesMessage
Messages
--------
.. autoclass:: tildee.models.TildesConversation
:members:
.. autoclass:: tildee.models.TildesWikiPage
.. autoclass:: tildee.models.TildesMessage
:members:

+ 1
- 1
tildee/__init__.py View File

@ -36,7 +36,7 @@ class TildesClient:
totp_code: Optional[str] = None,
base_url: str = "https://tildes.net",
verify_ssl: bool = True,
ratelimit: int = 500
ratelimit: int = 500,
):
self.username = username
self.base_url = base_url


Loading…
Cancel
Save