Repository: incubator-airflow Updated Branches: refs/heads/master a2ed55f2c -> 4a84a578a
Add an Apache Incubator Disclaimer and mocking modules Closes #1634 from mistercrunch/mock_docs Adding an Apache Incubator Disclaimer and mocking modules Project: http://git-wip-us.apache.org/repos/asf/incubator-airflow/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-airflow/commit/4a84a578 Tree: http://git-wip-us.apache.org/repos/asf/incubator-airflow/tree/4a84a578 Diff: http://git-wip-us.apache.org/repos/asf/incubator-airflow/diff/4a84a578 Branch: refs/heads/master Commit: 4a84a578a5a85085cfc12406442c4b87274d39df Parents: a2ed55f Author: Maxime Beauchemin <[email protected]> Authored: Wed Jun 29 13:39:15 2016 -0700 Committer: Maxime Beauchemin <[email protected]> Committed: Wed Jun 29 13:39:15 2016 -0700 ---------------------------------------------------------------------- airflow/models.py | 4 ++-- docs/code.rst | 13 ++++++------- docs/concepts.rst | 1 + docs/conf.py | 15 +++++++++++++++ docs/index.rst | 15 +++++++++++++-- setup.py | 7 ++++--- 6 files changed, 41 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/4a84a578/airflow/models.py ---------------------------------------------------------------------- diff --git a/airflow/models.py b/airflow/models.py index cccbad7..78e3d35 100644 --- a/airflow/models.py +++ b/airflow/models.py @@ -836,8 +836,8 @@ class TaskInstance(Base): Refreshes the task instance from the database based on the primary key :param lock_for_update: if True, indicates that the database should - lock the TaskInstance (issuing a FOR UPDATE clause) until the session - is committed. + lock the TaskInstance (issuing a FOR UPDATE clause) until the + session is committed. """ TI = TaskInstance http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/4a84a578/docs/code.rst ---------------------------------------------------------------------- diff --git a/docs/code.rst b/docs/code.rst index 8ffb6e4..ba1cddb 100644 --- a/docs/code.rst +++ b/docs/code.rst @@ -90,13 +90,13 @@ Community-contributed Operators .. automodule:: airflow.contrib.operators :show-inheritance: :members: - BigQueryOperator, - BigQueryToCloudStorageOperator, - GoogleCloudStorageDownloadOperator, SSHExecuteOperator, VerticaOperator, VerticaToHiveTransfer +.. autoclass:: airflow.contrib.operators.bigquery_operator.BigQueryOperator +.. autoclass:: airflow.contrib.operators.bigquery_to_gcs.BigQueryToCloudStorageOperator +.. autoclass:: airflow.contrib.operators.gcs_download_operator.GoogleCloudStorageDownloadOperator .. autoclass:: airflow.contrib.operators.QuboleOperator .. autoclass:: airflow.contrib.operators.hipchat_operator.HipChatAPIOperator .. autoclass:: airflow.contrib.operators.hipchat_operator.HipChatAPISendRoomNotificationOperator @@ -235,6 +235,8 @@ Community contributed hooks SSHHook, CloudantHook +.. autoclass:: airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook + Executors --------- Executors are the mechanism by which task instances get run. @@ -246,7 +248,4 @@ Executors are the mechanism by which task instances get run. Community-contributed executors ''''''''''''''''''''''''''''''' -.. automodule:: airflow.contrib.executors - :show-inheritance: - :members: - MesosExecutor +.. autoclass:: airflow.contrib.executors.mesos_executor.MesosExecutor http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/4a84a578/docs/concepts.rst ---------------------------------------------------------------------- diff --git a/docs/concepts.rst b/docs/concepts.rst index 31e7d61..8cfc8ab 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -664,6 +664,7 @@ configuration files, it allows you to expose the configuration that led to the related tasks in Airflow. .. code:: python + """ ### My great DAG """ http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/4a84a578/docs/conf.py ---------------------------------------------------------------------- diff --git a/docs/conf.py b/docs/conf.py index b0b5195..c462847 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,6 +13,21 @@ # serve to show the default. import os import sys +import mock + +MOCK_MODULES = [ + 'apiclient', + 'apiclient.discovery', + 'apiclient.http', + 'mesos', + 'mesos.interface', + 'mesos.native', + 'oauth2client.service_account', + 'pandas.io.gbq', +] +for mod_name in MOCK_MODULES: + sys.modules[mod_name] = mock.Mock() + # Hack to allow changing for piece of the code to behave differently while # the docs are being built. The main objective was to alter the http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/4a84a578/docs/index.rst ---------------------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 70f9355..c98d619 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,7 +5,19 @@ :width: 150 Apache Airflow (incubating) Documentation -================================ +========================================= + +.. note :: + + Apache Airflow is an effort undergoing incubation at The Apache + Software Foundation (ASF), sponsored by Chris Riccomini. + Incubation is required of all newly accepted projects until a further + review indicates that the infrastructure, communications, and + decision making process have stabilized in a manner consistent with + other successful ASF projects. While incubation status is not + necessarily a reflection of the completeness or stability of + the code, it does indicate that the project has yet to be fully + endorsed by the ASF. Airflow is a platform to programmatically author, schedule and monitor workflows. @@ -20,7 +32,6 @@ monitor progress, and troubleshoot issues when needed. When workflows are defined as code, they become more maintainable, versionable, testable, and collaborative. ------------- .. image:: img/airflow.gif http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/4a84a578/setup.py ---------------------------------------------------------------------- diff --git a/setup.py b/setup.py index 3fc77ff..e64ed36 100644 --- a/setup.py +++ b/setup.py @@ -250,9 +250,10 @@ def do_setup(): url='https://github.com/apache/incubator-airflow', download_url=( 'https://github.com/apache/incubator-airflow/tarball/' + version), - cmdclass={'test': Tox, - 'extra_clean': CleanCommand, - }, + cmdclass={ + 'test': Tox, + 'extra_clean': CleanCommand, + }, )
