apache/airflow

Automatic reference to configuration reference docs

Open

#10.260 geöffnet am 9. Aug. 2020

Auf GitHub ansehen
 (5 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (16.781 Forks)batch import
good first issuekind:documentationkind:feature

Repository-Metriken

Stars
 (44.809 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 7T 18h) (834 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide