https://github.com/cdslaborg/paramonte-kernel-doc
Doxygen documentation of the ParaMonte kernel library
https://github.com/cdslaborg/paramonte-kernel-doc
Last synced: 4 months ago
JSON representation
Doxygen documentation of the ParaMonte kernel library
- Host: GitHub
- URL: https://github.com/cdslaborg/paramonte-kernel-doc
- Owner: cdslaborg
- License: mit
- Created: 2020-12-17T00:30:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T19:03:54.000Z (about 2 years ago)
- Last Synced: 2025-09-09T23:38:41.137Z (10 months ago)
- Language: HTML
- Size: 232 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://github.com/cdslaborg/paramonted) repository.
### Instructions to regenerate the documentation
+ Install [Doxygen](https://www.doxygen.nl/download.html) on your system.
+ To regenerate the ParaMonte documentation from source,
+ 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.
+ Create a fork of the [ParaMonte kernel documentation project](https://github.com/cdslaborg/paramonte-kernel-doc/) on your personal
GitHub account and clone it inside the [src folder](https://github.com/cdslaborg/paramonte/tree/main/src) 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,
```bash
./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.
```bash
git add --all
git commit -m"latest documentation build"
git push --all
```
+ Open a pull request (PR) on the [ParaMonte documentation repository](https://github.com/cdslaborg/paramonte-kernel-doc/pulls)
to merge your new changes with the repository.
+ To generate new header, footer, or css stylesheet,
follow the [Doxygen instructions here](https://www.doxygen.nl/manual/config.html#cfg_html_header).
The regeneration command is the following:
```bash
doxygen -w html new_header.html new_footer.html new_stylesheet.css config.txt
```