Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Add Readthedocs #12

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = ParselyiOS
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/index.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: fc8f8b16a09b319e6af2ec94f89514e0
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/_build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/html/.doctrees/index.doctree
Binary file not shown.
56 changes: 56 additions & 0 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
.. image:: https://www.parse.ly/static/img/brand/logo-parsely-green-horizontal.png
:width: 155px
|

Parsely iOS's Quickstart Guide
=======================================

Integrating with XCode
-----------------------
To integrate Parse.ly mobile tracking with your iOS app:

#. Drag and drop the ParselyiOS folder into your XCode project
#. Check the box labeled "Copy items into destination Group's folder"
#. Ensure that the ``Foundation.framework`` and ``SystemConfiguration.framework`` frameworks are included in the `Link Binary with Libraries` build phase

Using the SDK
---------------
In any file that uses the Parsely SDK, be sure to add the line

::

import "ParselyTracker.h"

at the top of the file.

Before using the SDK, you must initialize the Parsely object with your public api key. This is usually best to do in the setup phase of your app, for example in the ``applicationDidFinishLaunchingWithOptions:`` method of the ``AppDelegate``.

::

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions{
self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
[ParselyTracker sharedInstanceWithApiKey:@"somesite.com"]; // initialize the Parsely tracker
[self.window makeKeyAndVisible];
return YES;
}

To register a pageview event with Parsely, simply use the ``trackURL:`` call.

::

[[ParselyTracker sharedInstance] trackURL:@"http://dailycaller.com/2013/03/19/alison-brie-is-the-future-of-television-photos/"];

This call requires the canonical URL of the page corresponding to the post currently being viewed.

.. toctree::
:maxdepth: 3
:caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Binary file added docs/_build/html/_static/ajax-loader.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading