You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "ASF subversion and git services (JIRA)" <ji...@apache.org> on 2018/05/21 19:59:00 UTC

[jira] [Commented] (AIRFLOW-2501) CONTRIBUTING.md missing develop extra for documentation build script

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

ASF subversion and git services commented on AIRFLOW-2501:
----------------------------------------------------------

Commit 702e62411b9b095fc6c28d78ccff7acc0853c00c in incubator-airflow's branch refs/heads/master from [~swast]
[ https://git-wip-us.apache.org/repos/asf?p=incubator-airflow.git;h=702e624 ]

[AIRFLOW-2501] Refer to devel instructions in docs contrib guide

Without the devel extra, the docs do not build.
The build fails due to
missing the mock package.

Closes #3395 from tswast/airflow-2501-docs-
contributing


> CONTRIBUTING.md missing develop extra for documentation build script
> --------------------------------------------------------------------
>
>                 Key: AIRFLOW-2501
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2501
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Tim Swast
>            Assignee: Tim Swast
>            Priority: Minor
>             Fix For: 2.0.0
>
>
> The [CONTRIBUTING.md|https://github.com/apache/incubator-airflow/blob/master/CONTRIBUTING.md] docs mention "you need to have installed airflow with the {{doc}} extra" but they do not mention that the development extras are also required. I attempted to do the minimal installation on a fresh virtualenv and got an import error.
>   
> {{$ pip install -e .}}
> {{...}}
> {{$ pip install -e .[doc]}}
>  {{...}}
>  {{$ cd docs}}
>  {{$ ./build.sh}}
>  {{rm: _build: No such file or directory}}
>  {{sphinx-build -b html -d _build/doctrees . _build/html}}
>  {{Running Sphinx v1.7.4}}{{Configuration error:}}
>  {{There is a programable error in your configuration file:}}{{Traceback (most recent call last):}}
>  {{ File "/Users/swast/.pyenv/versions/3.6.4/envs/airflow-py3/lib/python3.6/site-packages/sphinx/config.py", line 161, in __init__}}
>  \{{ execfile_(filename, config)}}
>  \{{ File "/Users/swast/.pyenv/versions/3.6.4/envs/airflow-py3/lib/python3.6/site-packages/sphinx/util/pycompat.py", line 150, in execfile_}}
>  \{{ exec_(code, _globals)}}
>  \{{ File "conf.py", line 16, in <module>}}
>  \{{ import mock}}
>  {{ModuleNotFoundError: No module named 'mock'}}{{make: *** [html] Error 2}}



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