Upload ROBODoc documentation to gh-pages project page

[zbeekman]

This is just a suggestion, but it might be nice to have the ROBODoc documentation online. The README.md could then link to the API documentation. I’m going to work on a feature branch to implement this in the CMake (and maybe build.sh) builds if you like the idea. I’ll send a pull request when I’m done.

I’m not sure whether or not it would make sense to also add something like a “publish” target (which would not be triggered with the “all” target) to automate publishing to gh-pages. To do this git commit and git push commands would have to be issued. CMake has machinery to find git, and script this in a makefile. However, having something like:

git clone git@github.com:jacobwilliams/json-fortran.git -b gh-pages ${CMAKE_CURRENT_BINARY_DIR}/documentation
cp -r ${CMAKE_CURRENT_BINARY_DIR}/doc_build/* ${CMAKE_CURRENT_BINARY_DIR}/documentation/
cd ${CMAKE_CURRENT_BINARY_DIR}/documentation
git commit --all -m “Automatically publishing ROBODoc generated documentation”
git push origin gh-pages
cd ..

but it does make me a bit nervous to be scripting git commits and pushes to remotes. One could also argue that it is less likely to make a typo if it is scripted and tested.

Since scripting the publishing of gh-pages with the build system is of no utility to end users I think it doesn’t make sense to include it.

Check out this page on GitHub help for some info on creating a project page.

[zbeekman]

Do you have a custom robodoc.rc? I ask because it seems ROBODoc (at least v4.99.41) doesn’t seem to recognize the ‘license’ item at line 30 of json_module.f90. I’m trying to see if there’s a way to get it to recognize this without using a custom robodoc.rc (i.e., command line arguments) but no luck yet.

[zbeekman]

Pull request #12 automates the documentation build with CMake.

[zbeekman]

I’ve put up an example on my branch at http://zbeekman.github.io/json-fortran if you want to check it out. If you put the API documentation online via gh-pages, then we should update the README.md to point there.

[jacobwilliams]

FYI: I fiddled with the headers a little bit. I switched LICENSE to COPYRIGHT, which is recognized by default. I'm going to clean it up a bit more later.

[jacobwilliams]

I like it. I'm going to go ahead and do the gh-pages thing.

[jacobwilliams]

Done. check it out.

[zbeekman]

Nice. I suggest adding the --documenttitle jsonfortran to the ROBODoc call. Also, right now I am adding the --sections flag which numbers the ToC. Looks good though.

[jacobwilliams]

Done.

[zbeekman]

Looks great. 👍 I’ll close the issue.