mik-laj commented on a change in pull request #4788: [AIRFLOW-3811][3/3] Add
automatic generation of API Reference
URL: https://github.com/apache/airflow/pull/4788#discussion_r267792232
##########
File path: docs/conf.py
##########
@@ -160,7 +161,39 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = [
+ '_build',
+ 'autoapi_templates',
+ '_autoapi/airflow/_vendor',
+ '_autoapi/airflow/api',
+ '_autoapi/airflow/bin',
+ '_autoapi/airflow/config_templates',
+ '_autoapi/airflow/configuration',
+ '_autoapi/airflow/contrib/auth',
+ '_autoapi/airflow/contrib/example_dags',
+ '_autoapi/airflow/contrib/utils',
+ '_autoapi/airflow/contrib/kubernetes',
+ '_autoapi/airflow/contrib/task_runner',
+ '_autoapi/airflow/contrib/index.rst',
Review comment:
I set a `autoapi_ignore` via code snippet
```python
# A list of patterns to ignore when finding files
autoapi_ignore =[os.path.join(os.path.dirname(__file__), directory) for
directory in [
'../airflow/_vendor',
'../airflow/api',
'../airflow/bin',
'../airflow/config_templates',
'../airflow/configuration',
'../airflow/contrib/auth',
'../airflow/contrib/example_dags',
'../airflow/contrib/utils',
'../airflow/contrib/kubernetes',
'../airflow/contrib/task_runner',
'../airflow/contrib/index.rst',
'../airflow/dag',
'../airflow/default_login',
'../airflow/example_dags',
'../airflow/exceptions',
'../airflow/lineage',
'../airflow/logging_config',
'../airflow/macros',
'../airflow/jobs',
'../airflow/plugins_manager',
'../airflow/security',
'../airflow/settings',
'../airflow/task',
'../airflow/ti_deps',
'../airflow/utils',
'../airflow/version',
'../airflow/www',
]]
```
Unfortunately, it did not work properly.
```python
Traceback (most recent call last):
File
"/root/.virtualenvs/airflow36/lib/python3.6/site-packages/astroid/builder.py",
line 166, in _data_build
node = _parse(data + "\n")
File
"/root/.virtualenvs/airflow36/lib/python3.6/site-packages/astroid/_ast.py",
line 31, in _parse
return parse_func(string)
File
"/root/.virtualenvs/airflow36/lib/python3.6/site-packages/typed_ast/ast3.py",
line 62, in parse
return _ast3._parse(source, filename, mode, feature_version)
File "<unknown>", line 18
print textmap[encoding]
^
SyntaxError: Missing parentheses in call to 'print'. Did you mean
print(textmap[encoding])?
```
It is caused by bad annotations in the pandas library.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
