Skip to content

Commit

Permalink
feat: IPA documentation (#4924)
Browse files Browse the repository at this point in the history
The main goal of this PR is to add documentation to the IPA that can be
viewed in doxygen. However, it also coincides with a slight refactor of
the class:
1. Using a mutex for multithreading instead of a vector of values
2.  Fixing the ipa benchmark

It also updates the doxygen file and adds a command "build_docs" to
cmake for convenience
  • Loading branch information
Rumata888 authored Mar 7, 2024
1 parent add91ca commit 48bd22e
Showing 5 changed files with 2,990 additions and 98 deletions.
12 changes: 12 additions & 0 deletions barretenberg/README.md
Original file line number Diff line number Diff line change
@@ -261,3 +261,15 @@ mv build build-native # your native build folders are mounted, but will not work
cmake --preset gcc ; cmake --build build
```
This will allow you to rebuild as efficiently as if you were running native code, and not have to see a full compile cycle.

### Building docs

If doxygen is installed on the system, you can use the **build_docs** target to build documentation, which can be configured in vscode CMake extension or using
```bash
cmake --build . --target build_docs
```
in the cpp/build directory. The documentation will be generated in cpp/docs/build folder. You can then run a python http server in the folder:
```bash
python3 -m http.server <port>
```
and tunnel the port through ssh.
9 changes: 9 additions & 0 deletions barretenberg/cpp/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -16,6 +16,15 @@ configure_file(
@ONLY
)

# Add doxygen build command
find_package(Doxygen)
if (DOXYGEN_FOUND)
add_custom_target(build_docs
COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_SOURCE_DIR}/docs/Doxyfile
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
COMMENT "Generate documentation with Doxygen")
endif(DOXYGEN_FOUND)

option(DISABLE_ASM "Disable custom assembly" OFF)
option(DISABLE_ADX "Disable ADX assembly variant" OFF)
option(MULTITHREADING "Enable multi-threading" ON)
Loading

0 comments on commit 48bd22e

Please sign in to comment.