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:
parent
efabb44b54
commit
00a7bf1be1
3 changed files with 155 additions and 4 deletions
35
docs/api.rst
35
docs/api.rst
|
@ -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:
|
|
@ -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,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue