[jira] [Commented] (AIRFLOW-2857) Fix verify_gpl_dependency for Read the Docs

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AIRFLOW-2857?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16569676#comment-16569676 ] 

ASF GitHub Bot commented on AIRFLOW-2857:
-----------------------------------------

tedmiston opened a new pull request #3703: [AIRFLOW-2857] Fix verify_gpl_dependency for Read the Docs
URL: https://github.com/apache/incubator-airflow/pull/3703
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-2857
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   Per the mailing list thread "Readthedocs is Broken" on Aug 5, 2018, the Read the Docs build process is currently broken per the recent addition of https://github.com/apache/incubator-airflow/pull/3660.
   
   The [RTD build environment](http://docs.readthedocs.io/en/latest/builds.html#build-environment) provides a `READTHEDOCS` env var boolean which it sets to true.  I have used that to toggle on `SLUGIFY_USES_TEXT_UNIDECODE` only when that env var is supplied to restrict it to that environment.
   
   Related change: The mock module [is used in conf.py](https://github.com/apache/incubator-airflow/blob/3157287e8c1aba7649cb7de80dd4026666889725/docs/conf.py#L16) is supplied to Sphinx to build the docs, but it was missing from the `doc` install extra in setup.py, so I've added that.
   
   Here's how I tested this:
   
   ```
   pip install -e .[doc]  # (fails)
   
   READTHEDOCS=True pip install -e .[doc]  # (succeeds)
   
   cd docs/
   ./build.sh
   ./start_doc_server.sh
   ```
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   A successful build on https://readthedocs.org/projects/airflow/builds/ will confirm that this is working in the Read the Docs environment.
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] In case of new functionality, my PR adds documentation that describes how to use it.
     - When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.
   
   ### Code Quality
   
   - [x] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Fix verify_gpl_dependency for Read the Docs
> -------------------------------------------
>
>                 Key: AIRFLOW-2857
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2857
>             Project: Apache Airflow
>          Issue Type: Bug
>            Reporter: Taylor Edmiston
>            Assignee: Taylor Edmiston
>            Priority: Major
>
> Per the mailing list thread "Readthedocs is Broken" on Aug 5, 2018, the Read the Docs build process is currently broken per the recent addition of [https://github.com/apache/incubator-airflow/pull/3660|https://github.com/apache/incubator-airflow/pull/3660.].



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)