Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
micahhausler committed Jan 8, 2015
1 parent 4644d44 commit 456ae2a
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ clean:
rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
$(SPHINXBUILD) -b html -W $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ Currently Supported Resources
* Applications (:doc:`API Reference <ref/applications>`)
* Application Hosts (:doc:`API Reference <ref/application_hosts>`)
* Application Instances (:doc:`API Reference <ref/application_instances>`)
* Browser Applications (:doc:`API Reference <ref/browser_applications>`)
* Components (:doc:`API Reference <ref/components>`)
* Key Transactions (:doc:`API Reference <ref/key_transactions>`)
* Labels (:doc:`API Reference <ref/labels>`)
* Notification Channels (:doc:`API Reference <ref/notification_channels>`)
* Plugins (:doc:`API Reference <ref/plugins>`)
* Servers (:doc:`API Reference <ref/servers>`)
Expand Down
14 changes: 14 additions & 0 deletions docs/ref/browser_applications.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _ref-browser_applications:

Browser Applications
====================

newrelic_api.browser_applications
---------------------------------

.. automodule:: newrelic_api.browser_applications
.. autoclass:: newrelic_api.browser_applications.BrowserApplications
:members:
:undoc-members:

.. automethod:: __init__
14 changes: 14 additions & 0 deletions docs/ref/labels.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _ref-labels:

Labels
======

newrelic_api.labels
-------------------

.. automodule:: newrelic_api.labels
.. autoclass:: newrelic_api.labels.Labels
:members:
:undoc-members:

.. automethod:: __init__
2 changes: 2 additions & 0 deletions docs/toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ Table of Contents
ref/applications
ref/application_hosts
ref/application_instances
ref/browser_applications
ref/components
ref/key_transactions
ref/labels
ref/notification_channels
ref/plugins
ref/servers
Expand Down
4 changes: 2 additions & 2 deletions newrelic_api/browser_applications.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ class BrowserApplications(Resource):
def list(self, filter_name=None, filter_ids=None, page=None):
"""
This API endpoint returns a list of the Browser Applications associated
with your New Relic account.
with your New Relic account.
Browser Applications can be filtered by their name, or by the
application IDs.
application IDs.
:type filter_name: str
:param filter_name: Filter by application name
Expand Down
4 changes: 2 additions & 2 deletions newrelic_api/labels.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def list(self, page=None):
def create(self, name, category, applications=None, servers=None):
"""
This API endpoint will create a new label with the provided name and
category
category
:type name: str
:param name: The name of the label
Expand Down Expand Up @@ -119,7 +119,7 @@ def create(self, name, category, applications=None, servers=None):
def delete(self, key):
"""
When applications are provided, this endpoint will remove those
applications from the label.
applications from the label.
When no applications are provided, this endpoint will remove the label.
Expand Down

0 comments on commit 456ae2a

Please sign in to comment.