modern-fortran / neural-fortran

A parallel framework for deep learning
MIT License
398 stars 82 forks source link

Replace PR #48: FORD commits only #49

Closed rouson closed 2 years ago

rouson commented 2 years ago

As requested in an issue comment, this PR contains only commits related to adding FORD documentation. The text below is mostly copied from the now-closed PR #48, which the current PR replaces.


  1. Add a top-level doc-generator.md FORD project file that produces HTML documentation inside doc/html/ and includes the top-level README.md content in the landing page: doc/html/index.html.
  2. Replaces ! with !! in comments only in the nf_random_mod just after the first line of the module and just after the first lines of the procedure interface bodies. Doing so triggers for to include the corresponding comments in the generated documentation.
  3. Add the doc/ subdirectory to the .gitignore file.

If this PR gets merged, then executing

cd neural-fortran
ford doc-generator.md

will produce an uncompressed version of doc.tar.gz.

If approved, this PR can be updated to apply similar changes to the rest of the files in src/:

rouson commented 2 years ago

@milancurcic this PR is now ready to merge. The documentation now contains lots of text from the comments in the code. See doc.tar.gz.

rouson commented 2 years ago

@milancurcic it appears that I don't have the privileges required to merge this PR.

milancurcic commented 2 years ago

OK, can you try now?

rouson commented 2 years ago

Yes, done. Thanks!