Skip to content

Commit 63e69c7

Browse files
committed
Added 'internal' docs for core/request modules.
1 parent f62f619 commit 63e69c7

3 files changed

Lines changed: 50 additions & 0 deletions

File tree

doc/api/core.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Core
2+
====
3+
4+
.. py:currentmodule:: github2.core
5+
6+
.. note::
7+
This module contains functionality that isn't useful to general users
8+
of the ``python-github2`` package, but it is documented to aid contributors
9+
to the package.
10+
11+
.. autofunction:: ghdate_to_datetime
12+
.. autofunction:: datetime_to_ghdate
13+
14+
.. autofunction:: commitdate_to_datetime
15+
.. autofunction:: datetime_to_commitdate
16+
17+
.. autofunction:: doc_generator
18+
19+
.. autoclass:: GithubCommand
20+
21+
.. autoclass:: Attribute
22+
23+
.. autoclass:: DateAttribute
24+
25+
.. autoclass:: BaseDataType

doc/api/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,12 @@ API documentation
1111
repos
1212
commit
1313
object
14+
15+
Additionally the following documentation may be useful to ``python-github2``
16+
contributors:
17+
18+
.. toctree::
19+
:maxdepth: 2
20+
21+
core
22+
request

doc/api/request.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Requests
2+
========
3+
4+
.. py:currentmodule:: github2.request
5+
6+
.. note::
7+
This module contains functionality that isn't useful to general users
8+
of the ``python-github2`` package, but it is documented to aid contributors
9+
to the package.
10+
11+
.. autodata:: GITHUB_URL
12+
13+
.. autoexception:: GithubError
14+
15+
.. autoclass:: GithubRequest
16+
:exclude-members: GithubError

0 commit comments

Comments
 (0)