Update docs with confval
definitions
#714
Labels
ci/doc
Issue related to documentation of the package
good first issue
Good for newcomers
help wanted
Extra attention is needed
triage/enhancement
New feature or request
Description
Currently, configuration settings are defined using custom definitions. For example:
weaver/docs/source/configuration.rst
Lines 106 to 117 in 72cc7d5
Sphinx provides a way to define
confval
directives, which can be referenced by:confval:`<ref>`
.This can be used to fix current workarounds using
:ref:
or`<ref>`_
references pointing at custom anchors before those settings, while providing nicer rendering.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: