Skip to content

Commit aa25773

Browse files
aschuman0Pete DavisPete Davis
authored
[TOOLSLIBS-16] Overhauled Sphinx Docs (#186)
* formats automation and pipeline * adds rtd theme * fixes anchor formatting * index updates * push and devices docs * adds tags, named user docs * adds audience and segmentation docs * typo * adds reports * small formatting fixes * more formatting cleanup * gitignore virtual env stuff * render copyright date, fix typo * not using _static dir, so removed to avoid build error * remove theme submodule * update license date Co-authored-by: Pete Davis <[email protected]> Co-authored-by: Pete Davis <[email protected]>
1 parent 0fb6296 commit aa25773

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+609
-2225
lines changed

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,10 @@ test_data.csv
1414
nosetests.xml
1515
.noseids
1616
/mypython
17-
ipynb/
17+
ipynb/
18+
19+
# Ignoring venv stuff
20+
bin/
21+
lib/
22+
man/
23+
pyvenv.cfg

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright 2020 Airship
1+
© Copyright 2009-2022, Airship Group, Inc.
22

33
Licensed under the Apache License, Version 2.0 (the "License");
44
you may not use this file except in compliance with the License.

docs/audience.rst

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
Audience and Segmentation
2+
**************************
3+
4+
Segments
5+
========
6+
Examples can be found in `the segments documentation here. <https://docs.airship.com/api/ua/?python#tag-segments>`_
7+
8+
.. autoclass:: urbanairship.devices.segment.Segment
9+
:members:
10+
:exclude-members: from_payload
11+
:noindex:
12+
13+
Segment Listing
14+
---------------
15+
Segment lists are fetched by instantiating an iterator object
16+
using :py:class:`SegmentList`.
17+
18+
.. autoclass:: urbanairship.devices.segment.SegmentList
19+
:members:
20+
21+
22+
Tags
23+
=====
24+
Examples can be found in `the tags documentation here. <https://docs.airship.com/api/ua/?python#tag-tags>`_
25+
26+
Channel Tags
27+
------------
28+
29+
.. automodule:: urbanairship.devices.tag
30+
:members: ChannelTags
31+
32+
Open Channel Tags
33+
------------------
34+
.. autoclass:: urbanairship.devices.tag.OpenChannelTags
35+
:members:
36+
37+
Email Channel Tags
38+
-------------------
39+
40+
.. autoclass:: urbanairship.devices.email.EmailTags
41+
:members:
42+
:noindex:
43+
44+
Named User Tags
45+
----------------
46+
47+
.. autoclass:: urbanairship.devices.named_users.NamedUserTags
48+
:members:
49+
:inherited-members:
50+
:noindex:
51+
52+
Named User
53+
===========
54+
A Named User is a proprietary identifier that maps customer-chosen IDs, e.g., CRM data, to Channels. It is useful to think of a Named User as an individual consumer who might have more than one mobile device registered with your app.
55+
56+
Examples can be found in `the named users documentation here. <https://docs.airship.com/api/ua/?python#tag-named-users>`_
57+
58+
.. autoclass:: urbanairship.devices.named_users.NamedUser
59+
:members:
60+
61+
Named User List
62+
---------------
63+
64+
.. autoclass:: urbanairship.devices.named_users.NamedUserList
65+
:members:
66+
:inherited-members:
67+
:noindex:
68+
69+
Attributes
70+
===========
71+
Define and manage attributes.
72+
73+
Examples can be found in `the attributes documentation here. <https://docs.airship.com/api/ua/?python#tag-attribute-lists>`_
74+
75+
.. autoclass:: urbanairship.devices.attributes.Attribute
76+
:members:
77+
78+
.. autoclass:: urbanairship.devices.attributes.ModifyAttributes
79+
:members:
80+
81+
82+
Lists
83+
======
84+
Create and manage audience lists.
85+
86+
Attribute Lists
87+
---------------
88+
Examples can be found in `the attributes documentation here. <https://docs.airship.com/api/ua/?python#tag-attribute-lists>`_
89+
90+
.. autoclass:: urbanairship.devices.attributes.AttributeList
91+
:members:
92+
93+
Subscription Lists
94+
-------------------
95+
Examples can be found in `the subscription lists documentation here. <https://docs.airship.com/api/ua/?python#operation-api-channels-subscription_lists-post>`_
96+
97+
.. autoclass:: urbanairship.devices.subscription_lists.SubscriptionList
98+
:members:
99+
100+
Static Lists
101+
------------
102+
Examples can be found in `the static lists documentation here. <https://docs.airship.com/api/ua/?python#tag-static-lists>`_
103+
104+
.. autoclass:: urbanairship.devices.static_lists.StaticList
105+
:members:
106+
107+
.. autoclass:: urbanairship.devices.static_lists.StaticLists
108+
:members:

docs/automation.rst

Lines changed: 0 additions & 202 deletions
This file was deleted.

0 commit comments

Comments
 (0)