Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.19 KB

README.md

File metadata and controls

26 lines (19 loc) · 1.19 KB
Raw

Instructions to regenerate the documentations

To regenerate the ParaMonte documentation from source,

  1. Create a fork of the ParaMonte project on your personal GitHub account and clone the forked ParaMonte repository on your system via,

    git clone --recurse-submodules [email protected]:cdslaborg/paramonte.git

  2. Open a Bash terminal and navigate to the root directory of the ParaMonte repository cloned on your system.

  3. Navigate from the ParaMonte root directory to the documentation repository's root folder ./external/paramonted.

  4. See the generic subfolder README.md file for instructions to regenerate the ParaMonte generic documentations.

  5. See the doxygen subfolder README.md file for instructions to regenerate ParaMonte language-specific Doxygen documentations.

NOTE

The ParaMonte documentation builds have only been tested on Linux system.