1
Fork 0
mirror of https://github.com/RGBCube/GitHubWrapper synced 2025-05-31 13:08:12 +00:00

Added Sphinx documentation to the client.py file

This commit is contained in:
sudosnok 2022-05-01 17:31:14 +01:00
parent 2b557f9953
commit 0de6781a96
6 changed files with 199 additions and 26 deletions

17
docs/api.rst Normal file
View file

@ -0,0 +1,17 @@
API Reference
=============
.. currentmodule:: github
Client
------
.. autoclass:: GHClient
:members:
API Models
----------
User
~~~~
.. autoclass:: User()
:members:

View file

@ -10,9 +10,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
# -- Project information -----------------------------------------------------
@ -28,6 +28,7 @@ author = 'Varmonke & sudosnok'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc"
]
# Add any paths that contain templates here, relative to this directory.

View file

@ -6,10 +6,16 @@
Welcome to Github-API-Wrapper's documentation!
==============================================
.. automodule:: github
.. toctree::
:maxdepth: 2
:caption: Contents:
api
Indices and tables