From e1c65513bb54eb7d56511fb9419ea429abe0fc25 Mon Sep 17 00:00:00 2001 From: John Keyes Date: Wed, 16 Nov 2016 11:20:27 +0000 Subject: [PATCH 1/2] Update references to Intercom API docs. --- README.rst | 2 +- docs/index.rst | 70 +++++++++++++++++++++++++------------------------- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/README.rst b/README.rst index 3bee8c0c..4bb43f4b 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ python-intercom Python bindings for the Intercom API (https://api.intercom.io). -`API Documentation `__. +`API Documentation `__. `Package Documentation `__. diff --git a/docs/index.rst b/docs/index.rst index 0c2f7efc..cebab721 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,10 +25,10 @@ If you want to use the latest code, you can grab it from our Usage =================================== -Authentication ---------------- +Authorization +------------- -Intercom documentation: `Authentication `_. +Intercom documentation: `Personal Access Tokens `_. :: @@ -42,7 +42,7 @@ Users Create or Update User +++++++++++++++++++++ -Intercom documentation: `Create or Update Users `_. +Intercom documentation: `Create or Update Users `_. :: @@ -52,7 +52,7 @@ Intercom documentation: `Create or Update Users `_. +Intercom documentation: `Updating the Last Seen Time `_. :: @@ -61,7 +61,7 @@ Intercom documentation: `Updating the Last Seen Time `_. +Intercom documentation: `List Users `_. :: @@ -71,7 +71,7 @@ Intercom documentation: `List Users `_. List by Tag, Segment, Company +++++++++++++++++++++++++++++ -Intercom documentation: `List by Tag, Segment, Company `_. +Intercom documentation: `List by Tag, Segment, Company `_. :: @@ -85,7 +85,7 @@ Intercom documentation: `List by Tag, Segment, Company `_. +Intercom documentation: `View a User `_. :: @@ -101,7 +101,7 @@ Intercom documentation: `View a User ` Delete a User +++++++++++++ -Intercom documentation: `Deleting a User `_. +Intercom documentation: `Deleting a User `_. :: @@ -121,7 +121,7 @@ Companies Create or Update Company ++++++++++++++++++++++++ -Intercom documentation: `Create or Update Company `_. +Intercom documentation: `Create or Update Company `_. :: @@ -130,7 +130,7 @@ Intercom documentation: `Create or Update Company `_. +Intercom documentation: `List Companies `_. :: @@ -140,7 +140,7 @@ Intercom documentation: `List Companies `_. +Intercom documentation: `List by Tag or Segment `_. :: @@ -153,7 +153,7 @@ Intercom documentation: `List by Tag or Segment `_. +Intercom documentation: `View a Company `_. :: @@ -162,7 +162,7 @@ Intercom documentation: `View a Company `_. +Intercom documentation: `List Company Users `_. :: @@ -176,7 +176,7 @@ Admins List Admins +++++++++++ -Intercom documentation: `List Admins `_. +Intercom documentation: `List Admins `_. :: @@ -190,7 +190,7 @@ Tags Create and Update Tags ++++++++++++++++++++++ -Intercom documentation: `Create and Update Tags `_. +Intercom documentation: `Create and Update Tags `_. :: @@ -206,7 +206,7 @@ Intercom documentation: `Create and Update Tags `_. +Intercom documentation: `Tag or Untag Users & Companies `_. :: @@ -219,7 +219,7 @@ Intercom documentation: `Tag or Untag Users & Companies `_. +Intercom documentation: `Delete a Tag `_. :: @@ -229,7 +229,7 @@ Intercom documentation: `Delete a Tag `_. +Intercom Documentation: `List Tags for an App `_. :: @@ -242,7 +242,7 @@ Segments List Segments +++++++++++++ -Intercom Documentation: `List Segments `_. +Intercom Documentation: `List Segments `_. :: @@ -254,7 +254,7 @@ Intercom Documentation: `List Segments `_. +Intercom Documentation: `View a Segment `_. :: @@ -266,7 +266,7 @@ Notes Create a Note +++++++++++++ -Intercom documentation: `Create a Note `_. +Intercom documentation: `Create a Note `_. :: @@ -278,7 +278,7 @@ Intercom documentation: `Create a Note `_. +Intercom documentation: `List Notes for a User `_. :: @@ -293,7 +293,7 @@ Intercom documentation: `List Notes for a User `_. +Intercom documentation: `View a Note `_. :: @@ -305,7 +305,7 @@ Events Submitting Events +++++++++++++++++ -Intercom documentation: `Submitting Events `_. +Intercom documentation: `Submitting Events `_. :: @@ -319,7 +319,7 @@ Counts Getting counts ++++++++++++++ -Intercom documentation: `Creating a Tag `_. +Intercom documentation: `Creating a Tag `_. :: @@ -355,7 +355,7 @@ Conversations Admin Initiated Conversation ++++++++++++++++++++++++++++ -Intercom documentation: `Admin Initiated Conversation `_. +Intercom documentation: `Admin Initiated Conversation `_. :: @@ -379,7 +379,7 @@ Intercom documentation: `Admin Initiated Conversation `_. +Intercom documentation: `User Initiated Conversation `_. :: @@ -395,7 +395,7 @@ Intercom documentation: `User Initiated Conversation `_. +Intercom documentation: `List Conversations `_. :: @@ -406,7 +406,7 @@ Intercom documentation: `List Conversations `_. +Intercom documentation: `Get a Single Conversation `_. :: @@ -415,7 +415,7 @@ Intercom documentation: `Get a Single Conversation `_. +Intercom documentation: `Replying to a Conversation `_. :: @@ -425,7 +425,7 @@ Intercom documentation: `Replying to a Conversation `_. +Intercom documentation: `Marking a Conversation as Read `_. :: @@ -439,7 +439,7 @@ Webhooks and Notifications Manage Subscriptions ++++++++++++++++++++ -Intercom documentation: `Manage Subscriptions `_. +Intercom documentation: `Manage Subscriptions `_. :: @@ -450,7 +450,7 @@ Intercom documentation: `Manage Subscriptions `_. +Intercom documentation: `View a Subscription `_. :: @@ -459,7 +459,7 @@ Intercom documentation: `View a Subscription `_. +Intercom documentation: `List Subscriptions `_. :: From 5d7cb63e17cbecd9451f17215c17993daeb53536 Mon Sep 17 00:00:00 2001 From: John Keyes Date: Wed, 16 Nov 2016 11:22:24 +0000 Subject: [PATCH 2/2] Update dev requirements with documentation requirements. --- dev-requirements.txt | 4 +++- docs/conf.py | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/dev-requirements.txt b/dev-requirements.txt index 906b0520..7c56d80b 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -4,4 +4,6 @@ nose==1.3.4 mock==1.0.1 coveralls==0.5 -coverage==3.7.1 \ No newline at end of file +coverage==3.7.1 +sphinx==1.4.8 +sphinx-rtd-theme==0.1.9 diff --git a/docs/conf.py b/docs/conf.py index bd82ab30..aeeaea68 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -58,7 +58,7 @@ import re with open(os.path.join(path_dir, 'intercom', '__init__.py')) as init: source = init.read() - m = re.search("__version__ = '(\d+\.\d+(\.(\d+|[a-z]+))?)'", source, re.M) + m = re.search("__version__ = '(.*)'", source, re.M) version = m.groups()[0] # The full version, including alpha/beta/rc tags.