https://github.com/cdslaborg/paramonted
ParaMonte library documentation
https://github.com/cdslaborg/paramonted
Last synced: 5 months ago
JSON representation
ParaMonte library documentation
- Host: GitHub
- URL: https://github.com/cdslaborg/paramonted
- Owner: cdslaborg
- License: other
- Created: 2024-03-04T05:27:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-24T20:20:36.000Z (over 1 year ago)
- Last Synced: 2024-12-24T21:21:55.757Z (over 1 year ago)
- Language: HTML
- Size: 46.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
### Instructions to regenerate the documentations
To regenerate the ParaMonte documentation from source,
1. Create a fork of the [ParaMonte project](https://github.com/cdslaborg/paramonte/)
on your personal GitHub account and clone the forked ParaMonte repository on your system via,
```bash
git clone --recurse-submodules git@github.com:cdslaborg/paramonte.git
```
1. Open a Bash terminal and navigate to the root directory of the ParaMonte repository cloned on your system.
1. Navigate from the ParaMonte root directory to the documentation repository's root folder `./external/paramonted`.
1. See the [generic subfolder README.md file](./generic/README.md) for instructions to regenerate the ParaMonte generic documentations.
1. See the [doxygen subfolder README.md file](./doxygen/README.md) for instructions to regenerate ParaMonte language-specific Doxygen documentations.
> **NOTE**
>
> The ParaMonte documentation builds have only been tested on Linux system.