search

astro-informatics / purify

Next-generation radio interferometric imaging.
https://astro-informatics.github.io/purify
GNU General Public License v2.0
17 stars 13 forks source link

Single manual file #90

Closed dpshelio closed 6 years ago

dpshelio commented 7 years ago

Use an automated way to keep consistency between the README.md file, manpage, and other type of documentation (e.g. website).

This will avoid to have multiple files to be updated.

@mdavezac via Slack: We could generate the readme and man page from a single file. Then all we need do is run it. Possibly add a check on jenkins.

Luke-Pratley commented 7 years ago

@dpshelio Is there a way that cmake can generate the files for us in the build process?

dpshelio commented 7 years ago

Maybe... or at least that calls some script and generates the man file in its right place...

Luke-Pratley commented 7 years ago

Another thing to look at is https://www.stack.nl/~dimitri/doxygen/manual/starting.html#man_out ? I thought we were using doxygen at some point, not sure if we still are.

Luke-Pratley commented 6 years ago

This can be done in the config file and README