search

FastTrackOrg / FastTrack

FastTrack is a cross-platform application designed to track multiple objects in video recording.
https://www.fasttrack.sh
GNU General Public License v3.0
101 stars 17 forks source link

Improvements to documentation generator script #28

Closed musicinmybrain closed 2 years ago

musicinmybrain commented 2 years ago

As a (Fedora) Linux distribution packager, I want to re-generate and install the user manual, but I would prefer not to have to generate the Doxygen internals documentation, since it is for FastTrack developers. This PR adds an optional argument to the generateDocumentation.sh script to allow generating either type of documentation alone.

Additionally, the nounset and errexit shell options are set for better error detection and reporting.

Finally, the section that amalgamates User_Manual.md is implemented a little differently to improve clarity and reduce repetition.

I’m happy to adjust this PR in response to any feedback you might have.

bgallois commented 2 years ago

Thanks, I just edited the commit messages to follow the naming convention.