Update docs with confval
definitions
#628
Labels
doc
Documentation improvements or building problem
enhancement
Improvements in term of performance or behaviour
Description
Currently, configuration settings are defined using
envvar
definitions with custom structures for default/types. For example:Magpie/docs/configuration.rst
Lines 549 to 554 in 2e57bef
Sphinx provides a way to define
confval
directives, which can be referenced by:confval:`<ref>`
(rather than:envvar:`<ref>`
).Using
confval
allows to directly making use of the directive to define:type:
and:default:
:Which would be rendered as:
int
(a number)This is a setting that controls the value of the answer.
References
The text was updated successfully, but these errors were encountered: