Documentation

[emgre]

Public interface documentation, as well as a simple guide.

Investigate the following:

• Vladimír Von­druš excellent doxygen theme, now with search support (example) Using this, and it works perfectly.
  Sphinx integration with Breathe (a few examples) Abandonned, doxygen alone is sufficient.
• Hosting
  • GitHub Pages: Working here: https://aegis4ics.github.io/modbus-cpp/
  • ReadTheDocs Support for doxygen is... bof.
  • Personnal AWS S3 GH Pages work, so abandon this.
• CircleCI integration Done, and it was harder than expected. The Docker image is here: https://hub.docker.com/r/emgre/circleci-doxygen/
• README information about building the documentation Done
• CMake target to build the documentation To be honest, I always build the documentation from a Docker image that doesn't have CMake and CI is already working. It's not that hard to do manually and the instructions in the README are clear. Let's not do this for now.
• General page to explain how to use the library, general guidance, etc. Done. We may add some more details, but I think it's a good start.
• Build documentation only in master branch before merging the doc code Done.

[emgre]

The documentation is offline until the public release. Branch gh-pages-private contains the CI builds of the documentation.