mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-15 09:44:04 +00:00

History

Johannes Halaoui de298f0d80 Add an option to disable storing graph data explicitly 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.		2022-12-07 11:28:00 -05:00
..
.gitignore	Refactor docs, make a new website.	2022-09-30 18:21:24 -04:00
CMakeLists.txt	Fix man page formatting.	2022-10-12 11:19:43 -04:00
config_settings.yaml	Add an option to disable storing graph data explicitly	2022-12-07 11:28:00 -05:00
lua.yaml	Fix create/destroy/set/get Lua Rsvg functions.	2022-10-16 13:00:05 -04:00
man.md.j2	Fix dates in man page.	2022-10-16 12:15:10 -05:00
README.md	More doc fixes.	2022-10-12 12:56:12 -04:00
render.py	Fix dates in man page.	2022-10-16 12:15:10 -05:00
variables.yaml	Drop unimplemented weather code.	2022-10-12 12:57:48 -04:00

README.md

Conky docs

There are 3 YAML files which contain the documentation:

variables.yaml: Documents each object/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 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 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 2 step process:

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

Run pandoc to 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.