Skip to content

Commit

Permalink
Docs tweaks while generating the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mistercrunch committed May 4, 2016
1 parent 3c3f5a6 commit aeb5a07
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
3 changes: 3 additions & 0 deletions airflow/bin/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -946,3 +946,6 @@ def get_parser(cls, dag_parser=False):
sp.add_argument(*arg.flags, **kwargs)
sp.set_defaults(func=sub['func'])
return parser

def get_parser():
return CLIFactory.get_parser()
15 changes: 7 additions & 8 deletions airflow/contrib/hooks/gcs_hook.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,26 @@
# limitations under the License.
#

import httplib2
import logging

from airflow.contrib.hooks.gc_base_hook import GoogleCloudBaseHook
from airflow.hooks.base_hook import BaseHook
from apiclient.discovery import build
from apiclient.http import MediaFileUpload
from oauth2client.client import SignedJwtAssertionCredentials

logging.getLogger("google_cloud_storage").setLevel(logging.INFO)


class GoogleCloudStorageHook(GoogleCloudBaseHook):
"""
Interact with Google Cloud Storage. Connections must be defined with an
extras JSON field containing:
{
"project": "<google project ID>",
"service_account": "<google service account email>",
"key_path": "<p12 key path>"
}
::
{
"project": "<google project ID>",
"service_account": "<google service account email>",
"key_path": "<p12 key path>"
}
If you have used ``gcloud auth`` to authenticate on the machine that's
running Airflow, you can exclude the service_account and key_path
Expand Down
8 changes: 5 additions & 3 deletions docs/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ Operator API
BashOperator,
BranchPythonOperator,
TriggerDagRunOperator,
DockerOperator,
DummyOperator,
EmailOperator,
ExternalTaskSensor,
Expand Down Expand Up @@ -82,6 +81,8 @@ Operator API
TimeSensor,
WebHdfsSensor

.. autoclass:: airflow.operators.docker_operator.DockerOperator


Community-contributed Operators
'''''''''''''''''''''''''''''''
Expand All @@ -92,12 +93,13 @@ Community-contributed Operators
BigQueryOperator,
BigQueryToCloudStorageOperator,
GoogleCloudStorageDownloadOperator,
HipChatAPIOperator,
HipChatAPISendRoomNotificationOperator,
SSHExecuteOperator,
VerticaOperator,
VerticaToHiveTransfer

.. autoclass:: airflow.contrib.operators.hipchat_operator.HipChatAPIOperator
.. autoclass:: airflow.contrib.operators.hipchat_operator.HipChatAPISendRoomNotificationOperator

.. _macros:

Macros
Expand Down
7 changes: 2 additions & 5 deletions docs/concepts.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
########
Concepts
########

The Airflow Platform is a tool for describing, executing, and monitoring
workflows.

**********
Core Ideas
**********
''''''''''

DAGs
====
Expand Down Expand Up @@ -250,9 +248,8 @@ be conceptualized like this:
By combining ``DAGs`` and ``Operators`` to create ``TaskInstances``, you can
build complex workflows.

************************
Additional Functionality
************************
''''''''''''''''''''''''

In addition to the core Airflow objects, there are a number of more complex
features that enable behaviors like limiting simultaneous access to resources,
Expand Down
2 changes: 1 addition & 1 deletion docs/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ run the commands below.
What's Next?
''''''''''''
From this point, you can head to the :doc:`tutorial` section for further examples or the :doc:`configuation` section if you're ready to get your hands dirty.
From this point, you can head to the :doc:`tutorial` section for further examples or the :doc:`configuration` section if you're ready to get your hands dirty.

0 comments on commit aeb5a07

Please sign in to comment.