mirror of
https://github.com/Llewellynvdm/conky.git
synced 2024-12-26 12:27:52 +00:00
de298f0d80
This option (store_graph_data_explicitly) can be disabled to use graphs indirectly via execpi or lua_parse. Otherwise the graph stays empty. The default value is true to keep avoiding resets while using conditional colors. |
||
|---|---|---|
| .. | ||
| .gitignore | ||
| CMakeLists.txt | ||
| config_settings.yaml | ||
| lua.yaml | ||
| man.md.j2 | ||
| README.md | ||
| render.py | ||
| variables.yaml | ||
Conky docs
There are 3 YAML files which contain the documentation:
variables.yaml: Documents each object/variableconfig_settings.yaml: Documents global configuration settingslua.yaml: Documents Conky's Lua API
The desc field within the docs can be formatted with markdown, however do
not include headings within the desc fields, as it will mess up the man page
output. In markdown, headings begin with #.
The supported documentation fields are:
name: the name of the thingdesc: a markdown-formatted description of the thingargs: optional list of argumentsdefault: 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 2 step
process:
- Run
render.pyto processman.md.j2:$ ./render.py man.md.j2 > man.md - Run
pandocto convert the markdown into a man page:$ 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.