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_r267749764
########## File path: docs/conf.py ########## @@ -363,3 +396,24 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False + +# sphinx-autoapi configuration +# See: +# https://sphinx-autoapi.readthedocs.io/en/latest/config.html + +# Paths (relative or absolute) to the source code that you wish to generate +# your API documentation from. +autoapi_dirs = [ + os.path.abspath('../airflow'), +] + +# A directory that has user-defined templates to override our default templates. +autoapi_template_dir = 'autoapi_templates' + +# Keep the AutoAPI generated files on the filesystem after the run. +# Useful for debugging. +autoapi_keep_files = False + +# Relative path to output the AutoAPI files into. This can also be used to place the generated documentation +# anywhere in your documentation hierarchy. +autoapi_root = '_autoapi' Review comment: What do you think about `_ap`i? the `_` symbol means that the file is generated automatically. It will be similar with other directories ```` https://airflow.readthedocs.io/en/latest/_modules/airflow/models.html#BaseOperator https://airflow.apache.org/_sources/index.rst.txt ```` ---------------------------------------------------------------- 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
