radiasoft / zgoubi

Git repo for zgoubi source code
https://sourceforge.net/projects/zgoubi/
GNU General Public License v2.0
9 stars 3 forks source link

Fix issue #9: Add ford documentation #24

Closed rouson closed 6 years ago

rouson commented 6 years ago

This pull request contains all of the commits from the cmake branch up plus one new commit that fixes issue #9 by adding a documentation-generation file formatted in Markdown for input to the FORtran Documentation (FORD) package. As described in the message for commit 0e99731fecde82ad580fd6efeacba8bdbcfcc54e , ./install.sh --documentation-only or ./install.sh -D now generates a doc subdirectory containing HTML files describing zgoubi's files, procedures, modules, and their interrelationships.

It might make sense to host the new HTML documents on a GitHub wiki associated with this repository. For now, I'm attaching a compressed archive of the generated files:

doc.tar.gz