Add an Apache Incubator Disclaimer and mocking modules

Closes apache#1634 from mistercrunch/mock_docs Adding an Apache Incubator Disclaimer and mocking modules
motte · Jun 29, 2016 · 4a84a57 · 4a84a57
1 parent a2ed55f
commit 4a84a57
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 14 deletions.
diff --git a/airflow/models.py b/airflow/models.py
@@ -836,8 +836,8 @@ def refresh_from_db(self, session=None, lock_for_update=False):
         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
 

diff --git 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
diff --git 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
     """

diff --git 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

diff --git 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

diff --git 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,
+        },
     )