search

ChildsplayOSU / bogl

Haskell implementation of the BoGL language
https://bogl.engr.oregonstate.edu
BSD 3-Clause "New" or "Revised" License
7 stars 1 forks source link

Integrates Haddock #137

Closed montymxb closed 4 years ago

montymxb commented 4 years ago

Closes #127 by starting to integrate haddock. Updates all files to produce complete documentation for haddock.

Still needs to be updated to auto-produce & publish haddock documentation under the GH-pages website for this project. This can be done automatically via Travis-CI, and only on the master when things are ready.

In addition, I'm going to run through and clear up as many of those warnings as I can in this same PR. Although we will be rewriting a large portion of the codebase in the coming year, it would be advantageous to do so on top of a clean and clearly documented body of work.

montymxb commented 4 years ago

New additions integrate haddock as part of the testing process for PRs. The standard tests via HUnit run first, and if they succeed they are followed by running stack haddock. If the source files fail to parse into docs this will cause the overall test result to fail, and will report accordingly.

If the test result passes, and the branch in question is master, an automatic deployment of the generated haddock will take place, which should end up in https://the-code-in-sheep-s-clothing.github.io/Spiel-Lang/haddock/ (once the first build on master completes).

montymxb commented 4 years ago

Going to move this in to verify that the haddock directory is successfully generated on the master. Changes look good other than that, nothing that should impact functionality.