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

Extend documentation on environment variables #583

Merged
merged 2 commits into from
Feb 29, 2024

Conversation

rgommers
Copy link
Contributor

  • cross link to the tables of compiler/linker flags in the Meson docs
  • mention PKG_CONFIG_PATH
  • add a warning about Conda's habit of injecting env vars also on the environment variables reference page

Closes gh-460

@rgommers rgommers added the documentation Improvements or additions to documentation label Feb 28, 2024
@rgommers
Copy link
Contributor Author

CI failure is Sphinx version too old:

Running Sphinx v4.5.0

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

Will add a second commit for that.

rgommers added a commit to rgommers/meson-python that referenced this pull request Feb 28, 2024
This should fix the CI failure that was visible on mesonbuildgh-583 due
to `sphinxcontrib.applehelp` at least requiring Sphinx 5.0.

Upgrading the Furo theme may also improve the html output; we're
pulling in almost two years worth of fixes here.

[skip cirrus]
Copy link
Member

@dnicolodi dnicolodi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rgommers. Looks nice, except a couple of small things.

docs/reference/environment-variables.rst Outdated Show resolved Hide resolved
docs/reference/environment-variables.rst Outdated Show resolved Hide resolved
rgommers added a commit to rgommers/meson-python that referenced this pull request Feb 29, 2024
This should fix the CI failure that was visible on mesonbuildgh-583 due
to `sphinxcontrib.applehelp` at least requiring Sphinx 5.0.

Upgrading the Furo theme may also improve the html output; we're
pulling in almost two years worth of fixes here.
@dnicolodi
Copy link
Member

Thanks @rgommers. I was indeed wondering why sphynx was pinned to such an old release. Just one more thing: maybe the commit messages should follow the usual convention and be prepended with DOC: and the remaining should not be capitalized.

- cross link to the tables of compiler/linker flags in the Meson docs
- mention `PKG_CONFIG_PATH`
- add a warning about Conda's habit of injecting env vars also on the
  environment variables reference page

Closes mesonbuildgh-460
This should fix the CI failure that was visible on mesonbuildgh-583 due
to `sphinxcontrib.applehelp` at least requiring Sphinx 5.0.

Upgrading the Furo theme may also improve the html output; we're
pulling in almost two years worth of fixes here.
@rgommers
Copy link
Contributor Author

Argh, forgot - fixed the commit messages now.

@dnicolodi dnicolodi merged commit b431df3 into mesonbuild:main Feb 29, 2024
39 of 41 checks passed
@rgommers rgommers deleted the docs-envvars branch February 29, 2024 08:46
@rgommers rgommers added this to the v0.16.0 milestone Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document environment variables used by Meson
2 participants