Updating Documentation

Generic Notes

• The documentation for CaPTk is present in https://cbica.github.io/CaPTk/

• This location is updated by GitHub automatically from the ${CaPTk_Sources}/docs folder [ref].

• All the documentation is in the *.txt files in the top-level of the repository, i.e., ${CaPTk_Sources}/*.txt.

Steps to edit documentation and update it on the Web

1. Ensure you have the option CAPTK_UPDATE_DOCS [ref] enabled from the CMake configuration. This option is enabled by default if the option BUILD_DOCUMENTATION_ONLY [ref] is selected.

2. After you update the contents of the desired text file, invoke Doxygen (1.8.9+) on your build directory using the command cmake --build . --target Documentation on Windows (or build the Documentation project on Visual Studio) or make Documentation on a GCC system.

3. Doxygen will generate the appropriate HTML files and CMake will copy them in ${CaPTk_Sources}/docs.

4. Push all changes (including the HTML files in the ${CaPTk_Sources}/docs folder) to your fork.

5. Once your fork gets merged with the master, the main documentation location, i.e., https://cbica.github.io/CaPTk/, gets updated automatically.