mirror of
https://github.com/clearlinux/telemetrics-client.git
synced 2026-06-16 02:35:52 +00:00
452c4d6ef5
We switched from .md files to .rst files a while ago in v1.11.1. Since then we genarate man pages using 'rst2man.py', hence the README.md file needs to be modified to reflect this change. (/usr/bin/ronn is actually not even availabel in CLR anymore) Signed-off-by: Juro Bystricky <juro.bystricky@intel.com>
414 B
414 B
Notes on manual pages
The manual pages are generated using rst2man.py. To recreate them,
run make manpages in the toplevel folder. If you want to edit
the documentation for upstream changes, make sure to edit the *.rst
files and not the shipped nroff output files.
Generating HTML documentation
At toplevel, run 'doxygen docs/Doxyfile'. The documentation is generated in the docs/html/ directory.