Conky docs

There are three YAML files that contain the documentation:

variables.yaml: Documents each object or variable
config_settings.yaml: Documents global configuration settings
lua.yaml: Documents Conky's Lua API

The desc field within the docs can be formatted with Markdown; however, do not include headings within desc fields, as that will break the man page output. In Markdown, headings begin with #.

The supported documentation fields are:

name: the name of the thing
desc: a markdown-formatted description of the thing
args: optional list of arguments
default: an optional default value, if applicable

Updating docs

The man page is based on man.md.j2, which is a Jinja2 template. The generated markdown is used to generate a final man page using pandoc. Generating the final man page is a two-step process:

Run render.py to process man.md.j2:
console
```
$ ./render.py man.md.j2 > man.md
```

Run pandoc to convert the markdown into a man page:

console

$ pandoc --standalone -f markdown -t man man.md > conky.1

These steps are also part of the CMake build, and can be executed by configuring the build with -DBUILD_DOCS=ON. When building the docs with CMake, target files are written to the CMake build directory, and not necessarily the same path as the source files.