mirror of
https://github.com/Llewellynvdm/conky.git
synced 2024-12-26 04:17:33 +00:00
670973a678
Generate the list of symbols for vim & nano syntax files using docs data + jinja2. Also refactored the doc handling a bit. |
||
|---|---|---|
| .. | ||
| .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
docgen.pyto processman.md.j2:$ ./docgen.py man.md.j2 > man.md - Run
pandocto convert the markdown into a man page:$ pandoc -f markdown -t 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.