1
Fork 0
mirror of https://github.com/RGBCube/GitHubWrapper synced 2025-05-20 07:55:09 +00:00

Added more documentation, not complete yet though

This commit is contained in:
sudosnok 2022-05-01 22:32:02 +01:00
parent efabb44b54
commit 00a7bf1be1
3 changed files with 155 additions and 4 deletions

View file

@ -11,7 +11,42 @@ Client
API Models
----------
APIObject
~~~~~~~~~
.. autoclass:: APIObject()
:members:
User
~~~~
.. autoclass:: User()
:members:
PartialUser
~~~~~~~~~~~
.. autoclass:: PartialUser()
:members:
Repository
~~~~~~~~~~
.. autoclass:: Repository()
:members:
Issue
~~~~~
.. autoclass:: Issue()
:members:
File
~~~~
.. autoclass:: File()
:members:
Gist
~~~~
.. autoclass:: Gist()
:members:
Organization
~~~~~~~~~~~~
.. autoclass:: Organization()
:members:

View file

@ -53,6 +53,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# a list of builtin themes.
#
html_theme = 'alabaster'
html_style = '/default.css'
html_favicon = './assets/Github-Python.png'
# Add any paths that contain custom static files (such as style sheets) here,