forked from trueagi-io/hyperon-experimental
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into fix-rustdocs
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
|
||
### Building C Documentation | ||
|
||
1. `doxygen` must be installed. Depending on your platform it may be easiest to use a package manager. | ||
- using apt: `sudo apt-get install doxygen` | ||
- using homebrew (Mac): `brew install doxygen` | ||
- installing from source: [https://www.doxygen.nl/manual/install.html] | ||
|
||
2. Build the Hyperon C library, following the instructions here: [https://github.com/trueagi-io/hyperon-experimental?tab=readme-ov-file#c-and-python-api] | ||
|
||
3. Set CMake environment variables. Relative to the `build` directory, run the following: | ||
- `export CMAKE_CURRENT_SOURCE_DIR=../c/` | ||
- `export HYPERONC_INCLUDE_DIR=./hyperonc-install/include/hyperonc/hyperon/` | ||
|
||
4. Invoke `doxygen` using the following command: `doxygen ../c/hyperonc.doxyfile` | ||
|
||
The top page for the rendered HTML results will be written to `./html/index.html`, and latex results will be similarly written to `./latex/index.tex` |