How to build the documentation and what is the format of it?
Rullec opened this issue · 4 comments
Hi,
Thanks for your effort in this lib! I am trying to learn the usage of matio, but failed. I cannot read the documentation given in this repo in a proper format cuz I have no idea about *.3
files. Would you please tell me what it is and how to manipulate it?
Thanks a lot.
Bests,
Xudong
I would answer myself:
the documention format is mdoc
, a format working specifically for man pages on UNIX systems. FYI there is an introduction link that introduces this format.
Also, the .3
format does have some meaning, which is depicted in this SO post
These .3
documents can be converted to pdf / html files, by mandoc
command on linux, i.e.
mandoc ./Mat_CreateVer.3 -Thtml > doc1.html
or
mandoc ./Mat_CreateVer.3 -Tpdf > doc1.pdf
Or have a look here:
matio/.ci/travis_after_success.sh
Line 15 in b3e56ed