Added Recipient Lists resource lib #48
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Running make docs-open 2015-08-28 09:29
. venv/bin/activate; cd docs && make html
sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v1.3.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 2 added, 3 changed, 2 removed
reading sources... [100%] resources/recipient_lists
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/api/recipient_lists.rst:4: WARNING: Title underline too short.
:mod:`sparkpost.recipient_lists`
=============================
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/api/transmissions.rst:6: WARNING: autodoc: failed to import class u'Transmission' from module u'sparkpost.transmission'; the following exception was raised:
Traceback (most recent call last):
File "/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/venv/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 385, in import_object
__import__(self.modname)
ImportError: No module named transmission
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/resources/recipient_lists.rst:2: WARNING: Title underline too short.
Recipient Lists
=============
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/resources/recipient_lists.rst:41: WARNING: Title underline too short.
Retrieve a recipient list
-----------------------
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/resources/recipient_lists.rst:53: WARNING: Title underline too short.
List all recipient lists
----------------------
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/resources/recipient_lists.rst:53: WARNING: Title underline too short.
List all recipient lists
----------------------
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/resources/recipient_lists.rst:81: ERROR: Unknown target name: "sparkpost recipient list api reference".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] resources/recipient_lists
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/sparkpost/recipient_lists.py:docstring of sparkpost.recipient_lists.RecipientLists.create:None: WARNING: more than one target found for cross-reference u'list': sparkpost.recipient_lists.RecipientLists.list, sparkpost.templates.Templates.list
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/sparkpost/recipient_lists.py:docstring of sparkpost.recipient_lists.RecipientLists.update:None: WARNING: more than one target found for cross-reference u'list': sparkpost.recipient_lists.RecipientLists.list, sparkpost.templates.Templates.list
generating indices... genindex py-modindex
writing additional pages... search
copying static files... WARNING: html_static_path entry u'/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/_static' does not exist
done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 10 warnings.
Build finished. The HTML pages are in _build/html.
. venv/bin/activate; open docs/_build/html/index.html |
| Additional documentation | ||
| ------------------------ | ||
|
|
||
| See the `SparkPost Recipient List API Reference`_. |
There was a problem hiding this comment.
This link is broken in the HTML output by make docs.
There was a problem hiding this comment.
It's Recipient List vs. Recipient Lists
|
Looks like just docs issues - other than that good to go. |
|
I see the following errors: make docs-open 2015-08-28 15:24
. venv/bin/activate; cd docs && make html
sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v1.3.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 2 source files that are out of date
updating environment: 0 added, 3 changed, 0 removed
reading sources... [100%] resources/recipient_lists
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/api/transmissions.rst:6: WARNING: autodoc: failed to import class u'Transmission' from module u'sparkpost.transmission'; the following exception was raised:
Traceback (most recent call last):
File "/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/venv/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 385, in import_object
__import__(self.modname)
ImportError: No module named transmission
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] resources/recipient_lists
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/sparkpost/recipient_lists.py:docstring of sparkpost.recipient_lists.RecipientLists.create:None: WARNING: more than one target found for cross-reference u'list': sparkpost.recipient_lists.RecipientLists.list, sparkpost.templates.Templates.list
/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/sparkpost/recipient_lists.py:docstring of sparkpost.recipient_lists.RecipientLists.update:None: WARNING: more than one target found for cross-reference u'list': sparkpost.recipient_lists.RecipientLists.list, sparkpost.templates.Templates.list
generating indices... genindex py-modindex
writing additional pages... search
copying static files... WARNING: html_static_path entry u'/Users/rleland/src/oss/reviews/python-sparkpost-aydrian/docs/_static' does not exist
done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 4 warnings.
Build finished. The HTML pages are in _build/html.
. venv/bin/activate; open docs/_build/html/index.htmlLooks like some references to the old |
|
All doc warnings are resolved with the exception of the |
richleland
added a commit
that referenced
this pull request
Sep 1, 2015
Added Recipient Lists resource lib
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #12
Take a look and see if we want to abstract it any further. I left passing the recipients objects as is.