docs: generate config value reference #1052
Conversation
LecrisUT
force-pushed
the
doc/config-ref
branch
3 times, most recently
from
b07e098 to
9c8ab10
Compare
henryiii
force-pushed
the
doc/config-ref
branch
from
9c8ab10 to
fc8ccc0
Compare
LecrisUT
force-pushed
the
doc/config-ref
branch
2 times, most recently
from
ca51653 to
d022b75
Compare
|
Truncating for the readme sounds good. Generating it into the files seems fine. I don't really like the page name, though. "Configurations" (when we have a "Configuration" already) seems odd. I think it should either match or be clearly different, like "Configuration reference". |
Naming is the nemesis of a developer 😉. I will try to see if |
|
That's fine, I just didn't like |
LecrisUT
force-pushed
the
doc/config-ref
branch
2 times, most recently
from
3d3b162 to
0f46489
Compare
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
henryiii
changed the title
2 participants
This would make it easier to cross-reference. I was debating going for an auto-generated one and integrating with sphinx directly or going with the
nox -t genfiles, and I think I prefer the latter because it makes it more obvious to review the generated text in all the places, wdyt?I also want to unlock usage of sphinx roles in it, but the readme generation gets in the way. My opinion is that if we have this, we could either move the readme part to the generated page, or truncate it to only display the first summary sentence similar to how
clickdoes it.Depends-on: #1051
Closes #999