The ParaMonte Kernel API Documentation

This project contains the Application Programming Interface documentation of the ParaMonte kernel library .
For full documentation visit the ParaMonte library's documentation website .

This repository is now archived permanently and will not be updated.
All ParaMonte library documentation source files are now located in the new paramonted repository.

Instructions to regenerate the documentation

• Install Doxygen on your system.

• To regenerate the ParaMonte documentation from source,

  • Create a fork of the ParaMonte project on your personal GitHub account and clone the forked ParaMonte repository on your system.
  • Create a fork of the ParaMonte kernel documentation project on your personal GitHub account and clone it inside the src folder of the ParaMonte repository.
  • When cloning is done, you should see a new subfolder /paramonte-kernel-doc in the /src folder of your local copy of ParaMonte Project.
  • Make any adjustments/updates as needed to the source of the documentation in the source files in /src/kernel subfolder.
  • Open a Bash terminal inside /src/paramonte-kernel-doc and make sure you are on the main branch of the documentation project,
  • Rebuild the new ParaMonte::Kernel documentation by calling the following script on the Bash command-line,

    ./build.sh

  • Inspect the message warning log of Doxygen in the output file READ_THESE_BUILD_WARNINGS.txt for any potential documentation errors.
  • Inspect the generated documentation by navigating to the /src/paramonte-kernel-doc/html folder and opening the index.html via a web browser. Make sure all new changes look fine in the browser.
  • If everything looks good, then stage, commit, and push the new documentation to your fork of the ParaMonte::Kernel documentation repository on GitHub.

    git add --all
    git commit -m"latest documentation build"
    git push --all

  • Open a pull request (PR) on the ParaMonte documentation repository to merge your new changes with the repository.

• To generate new header, footer, or css stylesheet, follow the Doxygen instructions here. The regeneration command is the following:

  doxygen -w html new_header.html new_footer.html new_stylesheet.css config.txt