Repository navigation
Feature request: auto-generate overview of config items for docs #10146
Description
Following up on #10139 (comment): "it would be really good if searching for "astropy configuration" didn't just return how to do configuration, but also all possible things one can configure. It should be possible to auto-generate a nice list..."
Looking very quickly at https://github.com/astropy/astropy/blob/master/astropy/config/configuration.py, it would seem that just following ConfigNamespace.__subclass__() should do the trick (though after loading all astropy modules...).
Activity
pllim commentedon Apr 14, 2020
@mhvk , can you please clarify with an example?
mhvk commentedon Apr 14, 2020
I would like to have a page in our docs like below, and hopefully auto-generate so it doesn't get out of date! Maybe some magic like the units listings is possible?
Configuration items
astropy.io.fits
enable_record_valued_keyword_cards: ... description ...
astropy.utils.iers
auto_max_age : ... description ...
saimn commentedon Apr 14, 2020
I thought the default config file was automatically generated, but actually it is hardcoded here: https://github.com/astropy/astropy/blob/master/astropy/astropy.cfg
So it has the list of items, but probably outdated (at least some io.fits ones are missing).
mhvk commentedon Apr 14, 2020
Yes,
iersstuff is missing too, but indeed auto-generating that would be useful, and it should not be difficult to then also include it in the docs.