This is an example module used to explain the structure of an HPX module.
The tool create_library_skeleton.py can be used to generate a basic skeleton. The structure of this skeleton is as follows:
README.rst should be always included which explains the basic purpose of
the library and a link to the generated documentation.
include directory should contain only headers that other libraries need.
For each of those headers, an automatic header test to check for self
containment will be generated. Private headers should be placed under the
src directory. This allows for clear seperation. The
may include additional CMake scripts needed to generate the respective build
Documentation is placed in the
docs folder. A empty skeleton for the index
is created, which is picked up by the main build system and will be part of the
generated documentation. Each header inside the
include directory will
automatically be processed by Doxygen and included into the documentation. If a
header should be excluded from the API reference, a comment
sphinx:undocumented needs to be added.
In order to consume any library defined here, all you have to do is use
target_link_libraries to get the dependencies. This of course requires that
the library to link against specified the appropriate target include directories