Skip to content

Commit 4e4ef6a

Browse files
jkeyesjkeyes
committed
Updating documentation.
1 parent 0c112ce commit 4e4ef6a

11 files changed

+712
-140
lines changed

‎CHANGES.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Changelog
33
=========
44

5+
* 2.0.alpha
6+
* support for Intercom API v2
7+
* support for Python 3
58
* 0.2.10
69
* basic support for companies. `#18 <https://github.com/jkeyes/python-intercom/pull/18>`_. (https://github.com/cameronmaske)
710
* fixed User.delete. `#19 <https://github.com/jkeyes/python-intercom/pull/19>`_. (https://github.com/cameronmaske)

‎dev-requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@
44
nose==1.3.4
55
httpretty==0.8.6
66
mock==1.0.1
7+
coverage==3.7.1
8+
Sphinx==1.3.1

‎docs/api/intercom.api_operations.rst

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
intercom.api_operations package
2+
===============================
3+
4+
Submodules
5+
----------
6+
7+
intercom.api_operations.all module
8+
----------------------------------
9+
10+
.. automodule:: intercom.api_operations.all
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
intercom.api_operations.count module
16+
------------------------------------
17+
18+
.. automodule:: intercom.api_operations.count
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
intercom.api_operations.delete module
24+
-------------------------------------
25+
26+
.. automodule:: intercom.api_operations.delete
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
intercom.api_operations.find module
32+
-----------------------------------
33+
34+
.. automodule:: intercom.api_operations.find
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
intercom.api_operations.find_all module
40+
---------------------------------------
41+
42+
.. automodule:: intercom.api_operations.find_all
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
intercom.api_operations.load module
48+
-----------------------------------
49+
50+
.. automodule:: intercom.api_operations.load
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
intercom.api_operations.save module
56+
-----------------------------------
57+
58+
.. automodule:: intercom.api_operations.save
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
64+
Module contents
65+
---------------
66+
67+
.. automodule:: intercom.api_operations
68+
:members:
69+
:undoc-members:
70+
:show-inheritance:

‎docs/api/intercom.extended_api_operations.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
intercom.extended_api_operations package
2+
========================================
3+
4+
Submodules
5+
----------
6+
7+
intercom.extended_api_operations.reply module
8+
---------------------------------------------
9+
10+
.. automodule:: intercom.extended_api_operations.reply
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
intercom.extended_api_operations.users module
16+
---------------------------------------------
17+
18+
.. automodule:: intercom.extended_api_operations.users
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
24+
Module contents
25+
---------------
26+
27+
.. automodule:: intercom.extended_api_operations
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:

‎docs/api/intercom.generic_handlers.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
intercom.generic_handlers package
2+
=================================
3+
4+
Submodules
5+
----------
6+
7+
intercom.generic_handlers.base_handler module
8+
---------------------------------------------
9+
10+
.. automodule:: intercom.generic_handlers.base_handler
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
intercom.generic_handlers.count module
16+
--------------------------------------
17+
18+
.. automodule:: intercom.generic_handlers.count
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
intercom.generic_handlers.tag module
24+
------------------------------------
25+
26+
.. automodule:: intercom.generic_handlers.tag
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
intercom.generic_handlers.tag_find_all module
32+
---------------------------------------------
33+
34+
.. automodule:: intercom.generic_handlers.tag_find_all
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: intercom.generic_handlers
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:

‎docs/api/intercom.lib.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
intercom.lib package
2+
====================
3+
4+
Submodules
5+
----------
6+
7+
intercom.lib.flat_store module
8+
------------------------------
9+
10+
.. automodule:: intercom.lib.flat_store
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
intercom.lib.setter_property module
16+
-----------------------------------
17+
18+
.. automodule:: intercom.lib.setter_property
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
intercom.lib.typed_json_deserializer module
24+
-------------------------------------------
25+
26+
.. automodule:: intercom.lib.typed_json_deserializer
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
Module contents
33+
---------------
34+
35+
.. automodule:: intercom.lib
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:

‎docs/api/intercom.rst

Lines changed: 122 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,153 @@
1-
intercom Package
1+
intercom package
22
================
33

4-
:mod:`intercom` Package
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
9+
intercom.api_operations
10+
intercom.extended_api_operations
11+
intercom.generic_handlers
12+
intercom.lib
13+
intercom.traits
14+
15+
Submodules
16+
----------
17+
18+
intercom.admin module
19+
---------------------
20+
21+
.. automodule:: intercom.admin
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
26+
intercom.collection_proxy module
27+
--------------------------------
28+
29+
.. automodule:: intercom.collection_proxy
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:
33+
34+
intercom.company module
535
-----------------------
636

7-
.. automodule:: intercom.__init__
37+
.. automodule:: intercom.company
838
:members:
939
:undoc-members:
1040
:show-inheritance:
1141

12-
:mod:`impression` Module
13-
------------------------
42+
intercom.conversation module
43+
----------------------------
1444

15-
.. automodule:: intercom.impression
45+
.. automodule:: intercom.conversation
1646
:members:
1747
:undoc-members:
1848
:show-inheritance:
1949

20-
:mod:`intercom` Module
50+
intercom.count module
51+
---------------------
52+
53+
.. automodule:: intercom.count
54+
:members:
55+
:undoc-members:
56+
:show-inheritance:
57+
58+
intercom.errors module
2159
----------------------
2260

23-
.. automodule:: intercom.intercom
61+
.. automodule:: intercom.errors
2462
:members:
2563
:undoc-members:
2664
:show-inheritance:
2765

28-
:mod:`message_thread` Module
66+
intercom.event module
67+
---------------------
68+
69+
.. automodule:: intercom.event
70+
:members:
71+
:undoc-members:
72+
:show-inheritance:
73+
74+
intercom.message module
75+
-----------------------
76+
77+
.. automodule:: intercom.message
78+
:members:
79+
:undoc-members:
80+
:show-inheritance:
81+
82+
intercom.note module
83+
--------------------
84+
85+
.. automodule:: intercom.note
86+
:members:
87+
:undoc-members:
88+
:show-inheritance:
89+
90+
intercom.notification module
91+
----------------------------
92+
93+
.. automodule:: intercom.notification
94+
:members:
95+
:undoc-members:
96+
:show-inheritance:
97+
98+
intercom.request module
99+
-----------------------
100+
101+
.. automodule:: intercom.request
102+
:members:
103+
:undoc-members:
104+
:show-inheritance:
105+
106+
intercom.segment module
107+
-----------------------
108+
109+
.. automodule:: intercom.segment
110+
:members:
111+
:undoc-members:
112+
:show-inheritance:
113+
114+
intercom.subscription module
29115
----------------------------
30116

31-
.. automodule:: intercom.message_thread
117+
.. automodule:: intercom.subscription
32118
:members:
33119
:undoc-members:
34120
:show-inheritance:
35121

36-
:mod:`user` Module
37-
------------------
122+
intercom.tag module
123+
-------------------
124+
125+
.. automodule:: intercom.tag
126+
:members:
127+
:undoc-members:
128+
:show-inheritance:
129+
130+
intercom.user module
131+
--------------------
38132

39133
.. automodule:: intercom.user
40134
:members:
41135
:undoc-members:
42136
:show-inheritance:
43137

138+
intercom.utils module
139+
---------------------
140+
141+
.. automodule:: intercom.utils
142+
:members:
143+
:undoc-members:
144+
:show-inheritance:
145+
146+
147+
Module contents
148+
---------------
149+
150+
.. automodule:: intercom
151+
:members:
152+
:undoc-members:
153+
:show-inheritance:

0 commit comments

Comments
 (0)