Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements #16

Merged
merged 8 commits into from
Dec 7, 2022
Merged

Documentation improvements #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c35a2ff
Added link to Meeting C++ video with benchmarks on Poacher
JPenuchot Dec 5, 2022
257b98e
Documentation title changed to CMake API reference
JPenuchot Dec 5, 2022
83e5eb8
Added message in case branch is not main
JPenuchot Dec 5, 2022
65df679
Trying to fix wrong condition on current branch
JPenuchot Dec 5, 2022
49e30c4
Fixed wrong condition on current branch for doc building
JPenuchot Dec 5, 2022
89e1195
Fixed formatting for doxygen docs
JPenuchot Dec 5, 2022
0686ef4
Improved docs: added graphs, added link to CMake API reference in the…
JPenuchot Dec 7, 2022
15339ef
Added two example graphs for the readme
JPenuchot Dec 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmake/ctbench-api.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#! # CMake documentation
#! # CMake API reference

## =============================================================================
#@
Expand Down
5 changes: 3 additions & 2 deletions cmake/docs.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Documentation options
set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_EXCLUDE_PATTERNS */build/* */tests/* */build-docs/*)
set(DOXYGEN_EXCLUDE_PATTERNS */build/* */tests/* */build-docs/* paper.md)
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ${CMAKE_SOURCE_DIR}/readme.md)
set(DOXYGEN_EXAMPLE_PATH ${CMAKE_SOURCE_DIR})
set(DOXYGENT_DOT_TRANSPARENT YES)
set(DOXYGEN_DOT_TRANSPARENT YES)
set(DOXYGEN_IMAGE_PATH ${CMAKE_SOURCE_DIR})

# ==============================================================================
# Doxygen Awesome CSS
Expand Down
Loading