diff options
author | Brad King <brad.king@kitware.com> | 2018-04-19 12:50:06 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2018-04-19 13:02:44 (GMT) |
commit | 8acf46caf11c037c76a221ec0b32803f75b03275 (patch) | |
tree | 3a12048f638afad90208bb8edafd00195df256ee /README.rst | |
parent | 7e532abc78ddd44cfd2e2ee3fd54e332f7a0e84d (diff) | |
download | CMake-8acf46caf11c037c76a221ec0b32803f75b03275.zip CMake-8acf46caf11c037c76a221ec0b32803f75b03275.tar.gz CMake-8acf46caf11c037c76a221ec0b32803f75b03275.tar.bz2 |
Utilities/Sphinx: Add role and directive for 'envvar' in CMake domain
This enables cross-reference syntax for CMake environment variables:
:envvar:`SOMEVAR`
and definition of CMake environment variables via a directive:
.. envvar:: SOMEVAR
It also adds environment variables defined by the directive and by
`Help/envvar/SOMEVAR.rst` documents to the index.
This `envvar` role and directive is defined in our `cmake` domain
and overrides the equivalent `envvar` role and directive provided
by Sphinx in its default domain. This is okay because we build
CMake documents in the `cmakd` domain.
This follows up the work from commit v3.10.0-rc1~43^2 (Help: Document
CMake's environment variables, 2017-09-01) that originally added
`envvar` documentation.
Diffstat (limited to 'README.rst')
0 files changed, 0 insertions, 0 deletions