docs: env var doc improvements (#8777)

## Summary

* Env docs now support anchors, which allows sending a link to someone
with a direct reference to an env var or cross-reference them in the
docs.
* Marked additional env vars as hidden from the docs due to their
internal use
* Updates some tests still using literals to use the static env vars

## Test Plan

<img width="1370" alt="env_var_anchors"
src="https://github.com/user-attachments/assets/52ae1caa-5199-4798-9eb5-81b8f5b57c24">
This commit is contained in:
samypr100 2024-11-03 18:56:17 +00:00 committed by GitHub
parent f52814e729
commit 647494b998
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 130 additions and 131 deletions

View file

@ -88,7 +88,9 @@ fn generate() -> String {
})
.collect::<Vec<_>>()
.join("\n");
output.push_str(&format!("- `{var}`: {doc}\n"));
output.push_str(&format!(
"- <a id=\"{var}\"></a> [`{var}`](#{var}): {doc}\n"
));
}
output