Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all config expansions in a single page #3326

Open
ssbarnea opened this issue Aug 13, 2024 · 1 comment
Open

Document all config expansions in a single page #3326

ssbarnea opened this issue Aug 13, 2024 · 1 comment

Comments

@ssbarnea
Copy link
Member

Issue

I want to have one documentation page that lists all expansions made by tox when loading its config, with the kind of values they would have. Example:

  • basepython - full path to python interpreter
  • env_name - name of the environment
  • env_dir - path to the environment
  • env_tmp_dir - {work_dir}/{env_name}/tmp
  • passargs- ...

It should be noted that most of these do have some documentation, but they are not listed in a centralized space, making hard to determine what you could use.

I am curious if there is a programmatic way to generate these as I would also find it useful to list them with --help.

@gaborbernat
Copy link
Member

You can refer to anything on https://tox.wiki/en/4.18.0/config.html really, so that page is the doc. We could add a const label to some, which are the injected values.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants