search

tbeu / matio

MATLAB MAT File I/O Library
https://matio.sourceforge.io
BSD 2-Clause "Simplified" License
338 stars 97 forks source link

How to build the documentation and what is the format of it? #180

Closed Rullec closed 2 years ago

Rullec commented 2 years ago

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

Rullec commented 2 years ago

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.

Rullec commented 2 years ago

Also, the .3 format does have some meaning, which is depicted in this SO post

Rullec commented 2 years ago

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
tbeu commented 2 years ago

Or have a look here: https://github.com/tbeu/matio/blob/b3e56ed363510e19179421d7365d05cdce0bf45f/.ci/travis_after_success.sh#L15