[GitHub] [airflow] jstern opened a new pull request #8095: stop rendering some class docs in wrong place

[GitBox]

jstern opened a new pull request #8095: stop rendering some class docs in wrong 
place
URL: https://github.com/apache/airflow/pull/8095
 
 
   Docs generated for providers.yandex.hooks incorrectly include docs for 
airflow.exceptions.AirflowException and airflow.hooks.base_hook.BaseHook in the 
yandex module, as if those classes had been defined in that module.
   
   This is almost certainly a bug in autoapi or one of the libraries it uses, 
but I haven't tracked down the root cause. In the meantime, importing the 
modules and then referring to the classes using modulename.Classname avoids the 
issue.
   
   Before this change, yandex docs include AirflowException and BaseHook under 
the wrong fully qualified names:
   
   <img width="763" alt="Screen Shot 2020-03-28 at 4 36 56 PM" 
src="https://user-images.githubusercontent.com/617540/77834402-87357900-7112-11ea-8561-43fe7941ada1.png";>
   
   After, yandex docs include only objects defined in that module:
   
   <img width="797" alt="Screen Shot 2020-04-03 at 8 28 46 AM" 
src="https://user-images.githubusercontent.com/617540/78365799-3d6ee780-7585-11ea-8033-0047a9105e43.png";>
   
   In addition to being wrong in and of itself, these docs being out of place 
are causing doc warnings in another PR where I have added `airflow.exceptions` 
to the api docs (https://github.com/apache/airflow/pull/7133).
   
   ---
   Make sure to mark the boxes below before creating PR: [x]
   
   - [x] Description above provides context of the change
   - [x] Unit tests coverage for changes (not needed for documentation changes)
   - [x] Commits follow "[How to write a good git commit 
message](http://chris.beams.io/posts/git-commit/)"
   - [x] Relevant documentation is updated including usage instructions.
   - [x] I will engage committers as explained in [Contribution Workflow 
Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
   
   ---
   In case of fundamental code change, Airflow Improvement Proposal 
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals))
 is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party 
License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in 
[UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
   Read the [Pull Request 
Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)
 for more information.
   

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