urbanairship 3.0.2 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +2 -0
- data/CHANGELOG +13 -0
- data/README.rst +111 -0
- data/docs/Makefile +192 -0
- data/docs/channel_uninstall.rst +21 -0
- data/docs/conf.py +293 -0
- data/docs/devices.rst +54 -0
- data/docs/examples.rst +118 -0
- data/docs/exceptions.rst +17 -0
- data/docs/index.rst +83 -0
- data/docs/named_user.rst +101 -0
- data/docs/push.rst +416 -0
- data/docs/reports.rst +303 -0
- data/docs/segment.rst +97 -0
- data/docs/tags.rst +49 -0
- data/lib/urbanairship/client.rb +20 -17
- data/lib/urbanairship/common.rb +47 -3
- data/lib/urbanairship/devices/channel_tags.rb +73 -0
- data/lib/urbanairship/devices/channel_uninstall.rb +35 -0
- data/lib/urbanairship/devices/devicelist.rb +61 -0
- data/lib/urbanairship/devices/named_user.rb +87 -0
- data/lib/urbanairship/devices/segment.rb +109 -0
- data/lib/urbanairship/loggable.rb +1 -0
- data/lib/urbanairship/push/audience.rb +1 -0
- data/lib/urbanairship/push/push.rb +12 -18
- data/lib/urbanairship/push/schedule.rb +1 -0
- data/lib/urbanairship/reports/per_push.rb +97 -0
- data/lib/urbanairship/reports/response_statistics.rb +157 -0
- data/lib/urbanairship/version.rb +1 -1
- data/lib/urbanairship.rb +9 -4
- data/urbanairship.gemspec +2 -2
- metadata +44 -25
- data/README.md +0 -96
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e23497d165bac0a9b80a28fdd159c05337c75e5c
|
4
|
+
data.tar.gz: 53ab68a5cf33e99d22d05d2ccca997e836e9a356
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 66cd9fea02af57d57d02ca0d410b2c611b40c0fd8fe9601cda546c77593ab1ecf7a8595858d9b4a5f40c53fbaa22687b9e438e270bc2932f8b8f4d813e498710
|
7
|
+
data.tar.gz: 5236b4f75d1e0f692d1fe381751d6b93d29c71048fe2a31c9698d85b8efb76053d30d70cdb97b9579165672b3cc198a8d14fc2d21cd415fc6a86cd1cd572c2b1
|
data/.gitignore
CHANGED
data/CHANGELOG
CHANGED
@@ -1,3 +1,16 @@
|
|
1
|
+
3.1.0
|
2
|
+
--------------------
|
3
|
+
- Added documentation files
|
4
|
+
- Added support for ChannelInfo and ChannelList
|
5
|
+
- Added support for segments
|
6
|
+
- Added support for channel uninstall
|
7
|
+
- Added support for tags
|
8
|
+
- Added support for feedback (device token and apid)
|
9
|
+
- Added support for named user
|
10
|
+
- Added support for reports
|
11
|
+
|
12
|
+
|
13
|
+
|
1
14
|
--------------------
|
2
15
|
3.0.2
|
3
16
|
--------------------
|
data/README.rst
ADDED
@@ -0,0 +1,111 @@
|
|
1
|
+
.. image:: https://travis-ci.org/urbanairship/ruby-library.svg?branch=master
|
2
|
+
:target: https://travis-ci.org/urbanairship/ruby-library
|
3
|
+
|
4
|
+
About
|
5
|
+
=====
|
6
|
+
|
7
|
+
``urbanairship`` is a Ruby library for using the `Urban Airship
|
8
|
+
<http://urbanairship.com/>`_ web service API for push notifications and rich
|
9
|
+
app pages.
|
10
|
+
|
11
|
+
Requirements
|
12
|
+
============
|
13
|
+
|
14
|
+
As of Version 3.0, a Ruby version >= 2.0 must be used.
|
15
|
+
|
16
|
+
Functionality
|
17
|
+
=============
|
18
|
+
|
19
|
+
Version 3.0 is a major upgrade and backwards incompatible with earlier versions.
|
20
|
+
|
21
|
+
To encourage the use of our SDK, which takes care of proper channel
|
22
|
+
registration, support for device token registration has been removed.
|
23
|
+
Support for v1 endpoints will also be removed and transitioned to their v3
|
24
|
+
equivalents where possible.
|
25
|
+
|
26
|
+
A more detailed list of changes can be found in the CHANGELOG.
|
27
|
+
|
28
|
+
Installation
|
29
|
+
============
|
30
|
+
|
31
|
+
If you have the ``bundler`` gem (if not you can get it with ``$ gem install bundler``) add this line to your application's Gemfile::
|
32
|
+
|
33
|
+
>>> gem 'urbanairship'
|
34
|
+
|
35
|
+
And then execute::
|
36
|
+
|
37
|
+
>>> $ bundle
|
38
|
+
|
39
|
+
OR install it yourself as::
|
40
|
+
|
41
|
+
>>> gem install urbanairship
|
42
|
+
|
43
|
+
Usage
|
44
|
+
=====
|
45
|
+
|
46
|
+
Once the gem has been installed you can start sending pushes!
|
47
|
+
See `api examples
|
48
|
+
<http://docs.urbanairship.com/topic-guides/api-examples.html>`_, for more
|
49
|
+
information.
|
50
|
+
|
51
|
+
Broadcast to All Devices
|
52
|
+
------------------------
|
53
|
+
|
54
|
+
>>> require 'urbanairship'
|
55
|
+
>>> UA = Urbanairship
|
56
|
+
>>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
|
57
|
+
>>> p = airship.create_push
|
58
|
+
>>> p.audience = UA.all
|
59
|
+
>>> p.notification = UA.notification(alert: 'Hello')
|
60
|
+
>>> p.device_types = UA.all
|
61
|
+
>>> p.send_push
|
62
|
+
|
63
|
+
Simple Tag Push
|
64
|
+
-------------------------------------------------
|
65
|
+
|
66
|
+
>>> require 'urbanairship'
|
67
|
+
>>> UA = Urbanairship
|
68
|
+
>>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
|
69
|
+
>>> p = airship.create_push
|
70
|
+
>>> p.audience = UA.tag('some_tag')
|
71
|
+
>>> p.notification = UA.notification(alert: 'Hello')
|
72
|
+
>>> p.device_types = UA.all
|
73
|
+
>>> p.send_push
|
74
|
+
|
75
|
+
Questions
|
76
|
+
=========
|
77
|
+
|
78
|
+
The best place to ask questions is our support site:
|
79
|
+
http://support.urbanairship.com/
|
80
|
+
|
81
|
+
Contributing
|
82
|
+
============
|
83
|
+
|
84
|
+
1. Fork it ( https://github.com/urbanairship/ruby-library )
|
85
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
86
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
87
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
88
|
+
5. Create a new Pull Request
|
89
|
+
6. Sign Urban Airship's [contribution agreement](http://docs.urbanairship.com/contribution-agreement.html)
|
90
|
+
Note: Changes will not be approved and merged without a signed contribution agreement
|
91
|
+
|
92
|
+
Development
|
93
|
+
===========
|
94
|
+
|
95
|
+
After checking out the repo, ensure you have ``bundler`` installed (``$ gem install bundler``) run::
|
96
|
+
|
97
|
+
>>> $ bin/setup
|
98
|
+
|
99
|
+
to install dependencies. Then, run::
|
100
|
+
|
101
|
+
>>> $ bin/console
|
102
|
+
|
103
|
+
for an interactive prompt that will allow you to experiment.
|
104
|
+
|
105
|
+
OR you can build a local gem to play with::
|
106
|
+
|
107
|
+
>>> $ gem build urbanairship.gemspec
|
108
|
+
>>> $ gem install ./urbanairship-<VERSION>.gem
|
109
|
+
|
110
|
+
Having a local build will give you better logging if you are running into issues, but be careful to make sure to use our released
|
111
|
+
public gem in Production.
|
data/docs/Makefile
ADDED
@@ -0,0 +1,192 @@
|
|
1
|
+
# Makefile for Sphinx documentation
|
2
|
+
#
|
3
|
+
|
4
|
+
# You can set these variables from the command line.
|
5
|
+
SPHINXOPTS =
|
6
|
+
SPHINXBUILD = sphinx-build
|
7
|
+
PAPER =
|
8
|
+
BUILDDIR = _build
|
9
|
+
|
10
|
+
# User-friendly check for sphinx-build
|
11
|
+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
12
|
+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
13
|
+
endif
|
14
|
+
|
15
|
+
# Internal variables.
|
16
|
+
PAPEROPT_a4 = -D latex_paper_size=a4
|
17
|
+
PAPEROPT_letter = -D latex_paper_size=letter
|
18
|
+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
19
|
+
# the i18n builder cannot share the environment and doctrees with the others
|
20
|
+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
21
|
+
|
22
|
+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
|
23
|
+
|
24
|
+
help:
|
25
|
+
@echo "Please use \`make <target>' where <target> is one of"
|
26
|
+
@echo " html to make standalone HTML files"
|
27
|
+
@echo " dirhtml to make HTML files named index.html in directories"
|
28
|
+
@echo " singlehtml to make a single large HTML file"
|
29
|
+
@echo " pickle to make pickle files"
|
30
|
+
@echo " json to make JSON files"
|
31
|
+
@echo " htmlhelp to make HTML files and a HTML help project"
|
32
|
+
@echo " qthelp to make HTML files and a qthelp project"
|
33
|
+
@echo " applehelp to make an Apple Help Book"
|
34
|
+
@echo " devhelp to make HTML files and a Devhelp project"
|
35
|
+
@echo " epub to make an epub"
|
36
|
+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
37
|
+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
38
|
+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
39
|
+
@echo " text to make text files"
|
40
|
+
@echo " man to make manual pages"
|
41
|
+
@echo " texinfo to make Texinfo files"
|
42
|
+
@echo " info to make Texinfo files and run them through makeinfo"
|
43
|
+
@echo " gettext to make PO message catalogs"
|
44
|
+
@echo " changes to make an overview of all changed/added/deprecated items"
|
45
|
+
@echo " xml to make Docutils-native XML files"
|
46
|
+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
47
|
+
@echo " linkcheck to check all external links for integrity"
|
48
|
+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
49
|
+
@echo " coverage to run coverage check of the documentation (if enabled)"
|
50
|
+
|
51
|
+
clean:
|
52
|
+
rm -rf $(BUILDDIR)/*
|
53
|
+
|
54
|
+
html:
|
55
|
+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
56
|
+
@echo
|
57
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
58
|
+
|
59
|
+
dirhtml:
|
60
|
+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
61
|
+
@echo
|
62
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
63
|
+
|
64
|
+
singlehtml:
|
65
|
+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
66
|
+
@echo
|
67
|
+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
68
|
+
|
69
|
+
pickle:
|
70
|
+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
71
|
+
@echo
|
72
|
+
@echo "Build finished; now you can process the pickle files."
|
73
|
+
|
74
|
+
json:
|
75
|
+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
76
|
+
@echo
|
77
|
+
@echo "Build finished; now you can process the JSON files."
|
78
|
+
|
79
|
+
htmlhelp:
|
80
|
+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
81
|
+
@echo
|
82
|
+
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
83
|
+
".hhp project file in $(BUILDDIR)/htmlhelp."
|
84
|
+
|
85
|
+
qthelp:
|
86
|
+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
87
|
+
@echo
|
88
|
+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
89
|
+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
90
|
+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ruby-library.qhcp"
|
91
|
+
@echo "To view the help file:"
|
92
|
+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ruby-library.qhc"
|
93
|
+
|
94
|
+
applehelp:
|
95
|
+
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
96
|
+
@echo
|
97
|
+
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
98
|
+
@echo "N.B. You won't be able to view it unless you put it in" \
|
99
|
+
"~/Library/Documentation/Help or install it in your application" \
|
100
|
+
"bundle."
|
101
|
+
|
102
|
+
devhelp:
|
103
|
+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
104
|
+
@echo
|
105
|
+
@echo "Build finished."
|
106
|
+
@echo "To view the help file:"
|
107
|
+
@echo "# mkdir -p $$HOME/.local/share/devhelp/ruby-library"
|
108
|
+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ruby-library"
|
109
|
+
@echo "# devhelp"
|
110
|
+
|
111
|
+
epub:
|
112
|
+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
113
|
+
@echo
|
114
|
+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
115
|
+
|
116
|
+
latex:
|
117
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
118
|
+
@echo
|
119
|
+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
120
|
+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
121
|
+
"(use \`make latexpdf' here to do that automatically)."
|
122
|
+
|
123
|
+
latexpdf:
|
124
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
125
|
+
@echo "Running LaTeX files through pdflatex..."
|
126
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
127
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
128
|
+
|
129
|
+
latexpdfja:
|
130
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
131
|
+
@echo "Running LaTeX files through platex and dvipdfmx..."
|
132
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
133
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
134
|
+
|
135
|
+
text:
|
136
|
+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
137
|
+
@echo
|
138
|
+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
139
|
+
|
140
|
+
man:
|
141
|
+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
142
|
+
@echo
|
143
|
+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
144
|
+
|
145
|
+
texinfo:
|
146
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
147
|
+
@echo
|
148
|
+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
149
|
+
@echo "Run \`make' in that directory to run these through makeinfo" \
|
150
|
+
"(use \`make info' here to do that automatically)."
|
151
|
+
|
152
|
+
info:
|
153
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
154
|
+
@echo "Running Texinfo files through makeinfo..."
|
155
|
+
make -C $(BUILDDIR)/texinfo info
|
156
|
+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
157
|
+
|
158
|
+
gettext:
|
159
|
+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
160
|
+
@echo
|
161
|
+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
162
|
+
|
163
|
+
changes:
|
164
|
+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
165
|
+
@echo
|
166
|
+
@echo "The overview file is in $(BUILDDIR)/changes."
|
167
|
+
|
168
|
+
linkcheck:
|
169
|
+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
170
|
+
@echo
|
171
|
+
@echo "Link check complete; look for any errors in the above output " \
|
172
|
+
"or in $(BUILDDIR)/linkcheck/output.txt."
|
173
|
+
|
174
|
+
doctest:
|
175
|
+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
176
|
+
@echo "Testing of doctests in the sources finished, look at the " \
|
177
|
+
"results in $(BUILDDIR)/doctest/output.txt."
|
178
|
+
|
179
|
+
coverage:
|
180
|
+
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
181
|
+
@echo "Testing of coverage in the sources finished, look at the " \
|
182
|
+
"results in $(BUILDDIR)/coverage/python.txt."
|
183
|
+
|
184
|
+
xml:
|
185
|
+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
186
|
+
@echo
|
187
|
+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
188
|
+
|
189
|
+
pseudoxml:
|
190
|
+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
191
|
+
@echo
|
192
|
+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
@@ -0,0 +1,21 @@
|
|
1
|
+
#################
|
2
|
+
Channel Uninstall
|
3
|
+
#################
|
4
|
+
|
5
|
+
Channels can be uninstalled using ``ChannelUninstall``. There is a limit of 200 channels that
|
6
|
+
can be uninstalled at one time. For more information, see `the API documentation
|
7
|
+
<http://docs.urbanairship.com/api/ua.html#uninstall-channels>`__.
|
8
|
+
|
9
|
+
.. sourcecode:: ruby
|
10
|
+
|
11
|
+
require 'urbanairship'
|
12
|
+
UA = Urbanairship
|
13
|
+
airship = UA::Client.new(key: 'app_key', secret: 'master_secret')
|
14
|
+
cu = UA::ChannelUninstall.new(client: airship)
|
15
|
+
|
16
|
+
chans = [{"channel_id" => "00000000-00000000-00000000-00000000",
|
17
|
+
"device_type" => "ios"},
|
18
|
+
{"channel_id" => "11111111-11111111-11111111-11111111",
|
19
|
+
"device_type" => "android"}]
|
20
|
+
|
21
|
+
cu.uninstall(channels: chans)
|
data/docs/conf.py
ADDED
@@ -0,0 +1,293 @@
|
|
1
|
+
# -*- coding: utf-8 -*-
|
2
|
+
#
|
3
|
+
# ruby-library documentation build configuration file, created by
|
4
|
+
# sphinx-quickstart on Thu Jul 23 12:51:57 2015.
|
5
|
+
#
|
6
|
+
# This file is execfile()d with the current directory set to its
|
7
|
+
# containing dir.
|
8
|
+
#
|
9
|
+
# Note that not all possible configuration values are present in this
|
10
|
+
# autogenerated file.
|
11
|
+
#
|
12
|
+
# All configuration values have a default; values that are commented out
|
13
|
+
# serve to show the default.
|
14
|
+
|
15
|
+
import sys
|
16
|
+
import os
|
17
|
+
import shlex
|
18
|
+
import re
|
19
|
+
|
20
|
+
# If extensions (or modules to document with autodoc) are in another directory,
|
21
|
+
# add these directories to sys.path here. If the directory is relative to the
|
22
|
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
23
|
+
#sys.path.insert(0, os.path.abspath('..'))
|
24
|
+
|
25
|
+
# -- General configuration ------------------------------------------------
|
26
|
+
|
27
|
+
# If your documentation needs a minimal Sphinx version, state it here.
|
28
|
+
needs_sphinx = '1.0'
|
29
|
+
|
30
|
+
# Add any Sphinx extension module names here, as strings. They can be
|
31
|
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
32
|
+
# ones.
|
33
|
+
extensions = ['sphinxcontrib.rubydomain']
|
34
|
+
|
35
|
+
# Add any paths that contain templates here, relative to this directory.
|
36
|
+
templates_path = ['_templates']
|
37
|
+
|
38
|
+
# The suffix(es) of source filenames.
|
39
|
+
# You can specify multiple suffix as a list of string:
|
40
|
+
# source_suffix = ['.rst', '.md']
|
41
|
+
source_suffix = '.rst'
|
42
|
+
|
43
|
+
# The encoding of source files.
|
44
|
+
#source_encoding = 'utf-8-sig'
|
45
|
+
|
46
|
+
# The master toctree document.
|
47
|
+
master_doc = 'index'
|
48
|
+
|
49
|
+
# General information about the project.
|
50
|
+
project = u'ruby-library'
|
51
|
+
copyright = u'2015, Urban Airship Ruby Library'
|
52
|
+
author = u'Urban Airship'
|
53
|
+
|
54
|
+
# The version info for the project you're documenting, acts as replacement for
|
55
|
+
# |version| and |release|, also used in various other places throughout the
|
56
|
+
# built documents.
|
57
|
+
|
58
|
+
# The full version
|
59
|
+
file = open('../lib/urbanairship/version.rb', 'r')
|
60
|
+
for line in file:
|
61
|
+
line = line.rstrip()
|
62
|
+
x = re.findall("VERSION = '([0-9.]+)", line)
|
63
|
+
if len(x) > 0:
|
64
|
+
release = x[0]
|
65
|
+
file.close()
|
66
|
+
#
|
67
|
+
# The short X.Y version.
|
68
|
+
version = re.match('\d\.\d', release).group()
|
69
|
+
|
70
|
+
# The language for content autogenerated by Sphinx. Refer to documentation
|
71
|
+
# for a list of supported languages.
|
72
|
+
#
|
73
|
+
# This is also used if you do content translation via gettext catalogs.
|
74
|
+
# Usually you set "language" from the command line for these cases.
|
75
|
+
#language = None
|
76
|
+
|
77
|
+
# There are two options for replacing |today|: either, you set today to some
|
78
|
+
# non-false value, then it is used:
|
79
|
+
#today = ''
|
80
|
+
# Else, today_fmt is used as the format for a strftime call.
|
81
|
+
#today_fmt = '%B %d, %Y'
|
82
|
+
|
83
|
+
# List of patterns, relative to source directory, that match files and
|
84
|
+
# directories to ignore when looking for source files.
|
85
|
+
exclude_patterns = ['_build']
|
86
|
+
|
87
|
+
# The reST default role (used for this markup: `text`) to use for all
|
88
|
+
# documents.
|
89
|
+
#default_role = None
|
90
|
+
|
91
|
+
# If true, '()' will be appended to :func: etc. cross-reference text.
|
92
|
+
#add_function_parentheses = True
|
93
|
+
|
94
|
+
# If true, the current module name will be prepended to all description
|
95
|
+
# unit titles (such as .. function::).
|
96
|
+
#add_module_names = True
|
97
|
+
|
98
|
+
# If true, sectionauthor and moduleauthor directives will be shown in the
|
99
|
+
# output. They are ignored by default.
|
100
|
+
#show_authors = False
|
101
|
+
|
102
|
+
# The name of the Pygments (syntax highlighting) style to use.
|
103
|
+
pygments_style = 'sphinx'
|
104
|
+
|
105
|
+
# A list of ignored prefixes for module index sorting.
|
106
|
+
#modindex_common_prefix = []
|
107
|
+
|
108
|
+
# If true, keep warnings as "system message" paragraphs in the built documents.
|
109
|
+
#keep_warnings = False
|
110
|
+
|
111
|
+
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
112
|
+
#todo_include_todos = False
|
113
|
+
|
114
|
+
|
115
|
+
# -- Options for HTML output ----------------------------------------------
|
116
|
+
|
117
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
118
|
+
# a list of builtin themes.
|
119
|
+
html_theme = 'urbanairship'
|
120
|
+
|
121
|
+
# Theme options are theme-specific and customize the look and feel of a theme
|
122
|
+
# further. For a list of options available for each theme, see the
|
123
|
+
# documentation.
|
124
|
+
#html_theme_options = {}
|
125
|
+
|
126
|
+
# Add any paths that contain custom themes here, relative to this directory.
|
127
|
+
sys.path.append(os.path.abspath('_themes'))
|
128
|
+
html_theme_path = ['_themes']
|
129
|
+
|
130
|
+
# The name for this set of Sphinx documents. If None, it defaults to
|
131
|
+
# "<project> v<release> documentation".
|
132
|
+
#html_title = None
|
133
|
+
|
134
|
+
# A shorter title for the navigation bar. Default is the same as html_title.
|
135
|
+
#html_short_title = None
|
136
|
+
|
137
|
+
# The name of an image file (relative to this directory) to place at the top
|
138
|
+
# of the sidebar.
|
139
|
+
#html_logo = None
|
140
|
+
|
141
|
+
# The name of an image file (within the static path) to use as favicon of the
|
142
|
+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
143
|
+
# pixels large.
|
144
|
+
#html_favicon = None
|
145
|
+
|
146
|
+
# Add any paths that contain custom static files (such as style sheets) here,
|
147
|
+
# relative to this directory. They are copied after the builtin static files,
|
148
|
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
149
|
+
# html_static_path = ['_static']
|
150
|
+
|
151
|
+
# Add any extra paths that contain custom files (such as robots.txt or
|
152
|
+
# .htaccess) here, relative to this directory. These files are copied
|
153
|
+
# directly to the root of the documentation.
|
154
|
+
#html_extra_path = []
|
155
|
+
|
156
|
+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
157
|
+
# using the given strftime format.
|
158
|
+
#html_last_updated_fmt = '%b %d, %Y'
|
159
|
+
|
160
|
+
# If true, SmartyPants will be used to convert quotes and dashes to
|
161
|
+
# typographically correct entities.
|
162
|
+
#html_use_smartypants = True
|
163
|
+
|
164
|
+
# Custom sidebar templates, maps document names to template names.
|
165
|
+
#html_sidebars = {}
|
166
|
+
|
167
|
+
# Additional templates that should be rendered to pages, maps page names to
|
168
|
+
# template names.
|
169
|
+
#html_additional_pages = {}
|
170
|
+
|
171
|
+
# If false, no module index is generated.
|
172
|
+
#html_domain_indices = True
|
173
|
+
|
174
|
+
# If false, no index is generated.
|
175
|
+
#html_use_index = True
|
176
|
+
|
177
|
+
# If true, the index is split into individual pages for each letter.
|
178
|
+
#html_split_index = False
|
179
|
+
|
180
|
+
# If true, links to the reST sources are added to the pages.
|
181
|
+
#html_show_sourcelink = True
|
182
|
+
|
183
|
+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
184
|
+
#html_show_sphinx = True
|
185
|
+
|
186
|
+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
187
|
+
#html_show_copyright = True
|
188
|
+
|
189
|
+
# If true, an OpenSearch description file will be output, and all pages will
|
190
|
+
# contain a <link> tag referring to it. The value of this option must be the
|
191
|
+
# base URL from which the finished HTML is served.
|
192
|
+
#html_use_opensearch = ''
|
193
|
+
|
194
|
+
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
195
|
+
#html_file_suffix = None
|
196
|
+
|
197
|
+
# Language to be used for generating the HTML full-text search index.
|
198
|
+
# Sphinx supports the following languages:
|
199
|
+
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
200
|
+
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
201
|
+
#html_search_language = 'en'
|
202
|
+
|
203
|
+
# A dictionary with options for the search language support, empty by default.
|
204
|
+
# Now only 'ja' uses this config value
|
205
|
+
#html_search_options = {'type': 'default'}
|
206
|
+
|
207
|
+
# The name of a javascript file (relative to the configuration directory) that
|
208
|
+
# implements a search results scorer. If empty, the default will be used.
|
209
|
+
#html_search_scorer = 'scorer.js'
|
210
|
+
|
211
|
+
# Output file base name for HTML help builder.
|
212
|
+
htmlhelp_basename = 'ruby-librarydoc'
|
213
|
+
|
214
|
+
# -- Options for LaTeX output ---------------------------------------------
|
215
|
+
|
216
|
+
latex_elements = {
|
217
|
+
# The paper size ('letterpaper' or 'a4paper').
|
218
|
+
#'papersize': 'letterpaper',
|
219
|
+
|
220
|
+
# The font size ('10pt', '11pt' or '12pt').
|
221
|
+
#'pointsize': '10pt',
|
222
|
+
|
223
|
+
# Additional stuff for the LaTeX preamble.
|
224
|
+
#'preamble': '',
|
225
|
+
|
226
|
+
# Latex figure (float) alignment
|
227
|
+
#'figure_align': 'htbp',
|
228
|
+
}
|
229
|
+
|
230
|
+
# Grouping the document tree into LaTeX files. List of tuples
|
231
|
+
# (source start file, target name, title,
|
232
|
+
# author, documentclass [howto, manual, or own class]).
|
233
|
+
latex_documents = [
|
234
|
+
(master_doc, 'ruby-library.tex', u'ruby-library Documentation',
|
235
|
+
u'Urban Airship', 'manual'),
|
236
|
+
]
|
237
|
+
|
238
|
+
# The name of an image file (relative to this directory) to place at the top of
|
239
|
+
# the title page.
|
240
|
+
#latex_logo = None
|
241
|
+
|
242
|
+
# For "manual" documents, if this is true, then toplevel headings are parts,
|
243
|
+
# not chapters.
|
244
|
+
#latex_use_parts = False
|
245
|
+
|
246
|
+
# If true, show page references after internal links.
|
247
|
+
#latex_show_pagerefs = False
|
248
|
+
|
249
|
+
# If true, show URL addresses after external links.
|
250
|
+
#latex_show_urls = False
|
251
|
+
|
252
|
+
# Documents to append as an appendix to all manuals.
|
253
|
+
#latex_appendices = []
|
254
|
+
|
255
|
+
# If false, no module index is generated.
|
256
|
+
#latex_domain_indices = True
|
257
|
+
|
258
|
+
|
259
|
+
# -- Options for manual page output ---------------------------------------
|
260
|
+
|
261
|
+
# One entry per manual page. List of tuples
|
262
|
+
# (source start file, name, description, authors, manual section).
|
263
|
+
man_pages = [
|
264
|
+
(master_doc, 'ruby-library', u'ruby-library Documentation',
|
265
|
+
[author], 1)
|
266
|
+
]
|
267
|
+
|
268
|
+
# If true, show URL addresses after external links.
|
269
|
+
#man_show_urls = False
|
270
|
+
|
271
|
+
|
272
|
+
# -- Options for Texinfo output -------------------------------------------
|
273
|
+
|
274
|
+
# Grouping the document tree into Texinfo files. List of tuples
|
275
|
+
# (source start file, target name, title, author,
|
276
|
+
# dir menu entry, description, category)
|
277
|
+
texinfo_documents = [
|
278
|
+
(master_doc, 'ruby-library', u'ruby-library Documentation',
|
279
|
+
author, 'ruby-library', 'One line description of project.',
|
280
|
+
'Miscellaneous'),
|
281
|
+
]
|
282
|
+
|
283
|
+
# Documents to append as an appendix to all manuals.
|
284
|
+
#texinfo_appendices = []
|
285
|
+
|
286
|
+
# If false, no module index is generated.
|
287
|
+
#texinfo_domain_indices = True
|
288
|
+
|
289
|
+
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
290
|
+
#texinfo_show_urls = 'footnote'
|
291
|
+
|
292
|
+
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
293
|
+
#texinfo_no_detailmenu = False
|