[GitHub] [airflow] mik-laj opened a new issue #10260: Automatic reference to configuration reference docs

[GitBox]

mik-laj opened a new issue #10260:
URL: https://github.com/apache/airflow/issues/10260


   Hello,
   
   I would like it to be possible to easily refer to the reference list with 
configuration options.  Currently, most of the guides that require a 
description of configuration options are similar to the description below.
   <img width="941" alt="Screenshot 2020-08-09 at 13 48 55" 
src="https://user-images.githubusercontent.com/12058428/89731407-177fb500-da47-11ea-9df5-8a17b910da35.png";>
   There are code literals in this text: ``backend``, ``[secrets]``. 
Unfortunately, these literals are just text and I wish they could be clicked to 
go to a reference list containing a description of the option/section.
   
   To do this, we should add a new reference type, make changes to the listing 
template, and then make changes to all descriptions. We can be inspired by the 
Django project.
   
https://github.com/django/django/blob/58a336a674a658c1cda6707fe1cacb56aaed3008/docs/_ext/djangodocs.py#L47-L52
   
   Best regards,
   Kamil Breguła


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