Update sphinx config (#196)

* Update sphinx version

* Update documents

Author: smaeda-ks

docs/source/conf.py

@@ -53,8 +53,8 @@
 
 # General information about the project.
 project = u'Twitter Ads API SDK for Python'
-copyright = u'2015, Twitter, Inc'
-author = u'Brandon Black'
+copyright = u'2019, Twitter, Inc'
+author = u'[email protected], [email protected], [email protected]'
 
 sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..'))
 from twitter_ads.utils import get_version
@@ -226,7 +226,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
   (master_doc, 'TwitterAdsAPISDKforPython.tex', u'Twitter Ads API SDK for Python Documentation',
-   u'Brandon Black', 'manual'),
+   u'[email protected], [email protected], [email protected]', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

docs/source/index.rst

@@ -6,10 +6,18 @@
    :hidden:
 
    twitter_ads/index
-   twitter_ads/code
    twitter_ads/account
    twitter_ads/audience
+   twitter_ads/campaign
+   twitter_ads/client
+   twitter_ads/creative
+   twitter_ads/cursor
+   twitter_ads/enum
    twitter_ads/error
+   twitter_ads/http
+   twitter_ads/resource
+   twitter_ads/targeting
+   twitter_ads/utils
 
 Getting Started
 ---------------
@@ -74,9 +82,9 @@ versions we officially support and regularly test against.
 +------------+-------------------------+
 | Platform   | Versions                |
 +============+=========================+
-| CPython    | 2.7, 3.3, 3.4, 3.5      |
+| CPython    | 2.7, 3.5, 3.6, 3.7      |
 +------------+-------------------------+
-| PyPy       | 2.x, 4.x                |
+| PyPy       | 7.x                     |
 +------------+-------------------------+
 
 All releases adhere to strict `semantic versioning`_. For Example,
@@ -116,7 +124,7 @@ License
 
 The MIT License (MIT)
 
-Copyright (C) 2015 Twitter, Inc.
+Copyright (C) 2019 Twitter, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/source/twitter_ads/tweet.rst

@@ -1,7 +1,6 @@
 pyyaml
 requests-oauthlib
 python-dateutil
-sphinx==1.3.1
 responses
 mock
 setuptools_scm

requirements.txt

@@ -1,6 +1,7 @@
 # Copyright (C) 2015 Twitter, Inc.
 
 import os
+import sys
 from setuptools import setup, find_packages
 
 DESCRIPTION = 'A Twitter supported and maintained Ads API SDK for Python.'
@@ -43,6 +44,9 @@ def get_version(version_tuple):
     'tests_require': ['pytest', 'responses', 'mock']
 }
 
+if sys.version_info[0] == 3:
+    extra_opts['setup_requires'].append('sphinx==2.1.1')
+
 setup(
     name='twitter-ads',
     version=VERSION,

setup.py

@@ -39,7 +39,7 @@ def users(self, params):
         """
         This is a private API and requires whitelisting from Twitter.
         This endpoint will allow partners to add, update and remove users from a given
-            tailored_audience_id.
+        tailored_audience_id.
         The endpoint will also accept multiple user identifier types per user as well.
         """
         resource = self.RESOURCE_USERS.format(account_id=self.account.id, id=self.id)

twitter_ads/audience.py

@@ -313,6 +313,10 @@ def async_stats_job_data(klass, account, url, **kwargs):
 
     @classmethod
     def active_entities(klass, account, start_time, end_time, **kwargs):
+        """
+        Returns the details about which entities' analytics metrics
+        have changed in a given time period.
+        """
         entity_type = klass.__name__
         if entity_type == 'OrganicTweet':
             raise ValueError("'OrganicTweet' not support with 'active_entities'")