"Suggest a change on this page" button bug/change request

[JavierLopezT]

Coming from google to the following web: https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/hooks/s3/index.html

The button 'Suggest a change on this page' doesn't work, it leads you to https://github.com/apache/airflow/edit/main/docs/apache-airflow-providers-amazon/_api/airflow/providers/amazon/aws/hooks/s3/index.rst

Also, I think the button is way too big and it makes "difficult" to read the documentation

[potiuk]

Yep. Agree. The API documentation is automatically generated and the "suggest a change" button makes no sense there. Maybe you could try to figure out how to remove it @JavierLopezT and make a PR to fix it ? @mik-laj might provide some hints.

[ShivamJhaa]

I will like to fix this bug.
Please assign me the task.
Thank you

[potiuk]

assigned!

[eladkal]

@ShivamJhaa are you still working on this issue?

[Megha-Sai-Sree-PINNAKA]

Hello, is this issue still available? If yes, I would like to try it.

[potiuk]

Sure.

[potiuk]

Assigned you

[Megha-Sai-Sree-PINNAKA]

Hello @potiuk. You mentioned that removing the suggest a change button would be better right as the documentation is automatically generated. Do you mean removing it in all the web pages or only from here https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/hooks/s3/index.html?

[potiuk]

All the auto-generated pages - those that have no corresponding .rst file but are generated from the python code.

[Megha-Sai-Sree-PINNAKA]

Hello @potiuk and @mik-laj

I understood that there are 2 ways to display the documentation on airflow website.

1. Through .rst files where any changes can be directly done on this file and will be reflected on the corresponding UI Page.
2. Through .py file. In case of amazon aws hooks (s3)the decorators and static methods are being used for the document generation on the HTML Page. But don’t have a default .rst file to make any direct changes so that it gets displayed on the UI.

Can you please provide me any pointers to know how the airflow site pages are being invoked from apache airflow repo?

[potiuk]

The .py files are generated by autoapi plugin - that's what I know. once the build is done, they are all generated in _api subfolder, so the most likely way to check it is to use the location of the source. But how exactly to do it, I am not sure - I am not a sphinx expert :)

[mik-laj]

Documentation for class is generated based on python files.

[qleroy]

The button is still way too large and makes parts of the page unreadable.

[potiuk]

The button is still way too large and makes parts of the page unreadable.

PRs to decreese it are most welcome. I think it's great to get it easy to contribute back to the documentation and many of our contributor use it. But If you feel it's too large @qleroy - I heartily invite you to do your first contribution and for example make a CSS that will adapt it, depending on the amount of available screen real estate. That would be great contribution.

[shivannakarthik]

@potiuk - If this is still open, I would like to pick it up.