REST_METADATA

Properties

Property

Data type

stdWrap

Default

path

string

yes

empty

(stdWrap properties)

stdWrap property

Property details

path

REST_METADATA.path = string

Path to the root directory of the documentation.

(stdWrap properties)

REST_METADATA.<stdWrap property> = stdWrap property

Available fields:

  • shorttitle

  • copyright

  • project

  • version

  • release

  • sphinx_version

  • ...

Tip

See globalcontext.json for additional fields.

Example

10 = REST_METADATA
10.field = copyright