Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
54305f5
chore: remove cppreference
realstealthninja Oct 8, 2024
9339fe9
feat: add doxyfile
realstealthninja Oct 8, 2024
a54220d
feat: add doxygen-awesome theme
realstealthninja Oct 8, 2024
5ff6961
chore: remove unneccessary doxygen config form cmake
realstealthninja Oct 8, 2024
59d3c84
test: for doxygen test purposes
realstealthninja Oct 8, 2024
7e7c3d1
fix: try removing css from rm
realstealthninja Oct 8, 2024
2127a8a
fix: set style sheet via cmake
realstealthninja Oct 8, 2024
8b5701a
feat: make doxygen theme finally work
realstealthninja Oct 8, 2024
6cb1bb9
fix: remove mathjax from doxyfile
realstealthninja Oct 8, 2024
5a1f34a
feat: add sidebar and make mathjax work
realstealthninja Oct 8, 2024
6905ae1
doc: add transparency and make output svg of dot
realstealthninja Oct 9, 2024
9036a74
fix: make dots interactive
realstealthninja Oct 9, 2024
03091af
chore: move math jax from cmake to doxyfile
realstealthninja Oct 9, 2024
2bb7ae8
feat: add header file
realstealthninja Oct 9, 2024
c011b67
chore: add header file to cmake
realstealthninja Oct 9, 2024
bd7d439
Merge branch 'TheAlgorithms:master' into doxygen-awesome
realstealthninja Oct 9, 2024
916eebd
chore: remove redundant transparency config
realstealthninja Oct 9, 2024
3341b51
fix: force cmake to use config file
realstealthninja Oct 9, 2024
ea2bb62
chore: remove working directory
realstealthninja Oct 9, 2024
a08a2ca
fix: use old add_docs command
realstealthninja Oct 9, 2024
a4a7679
feat: fix doxygen build
realstealthninja Oct 9, 2024
f44780f
fix: re enable clang assited parsing
realstealthninja Oct 9, 2024
da6b723
fix: use relative paths
realstealthninja Oct 9, 2024
d28bc20
fix: relative paths arent necessary
realstealthninja Oct 9, 2024
d431a44
feat: add project logo and favicon
realstealthninja Oct 9, 2024
23d2173
fix: revert gh-pages to master
realstealthninja Oct 9, 2024
01dc833
fix: add dot to doxyfile
realstealthninja Oct 9, 2024
e7c7ef4
fix: add lib clang to doxygen
realstealthninja Oct 9, 2024
c1de223
fix: use source browser
realstealthninja Oct 9, 2024
c3f23de
fix: add clang as compiler
realstealthninja Oct 9, 2024
994a521
docs: remove headers from source browser
realstealthninja Oct 9, 2024
0211940
Merge branch 'TheAlgorithms:master' into doxygen-awesome
realstealthninja Oct 10, 2024
61f2ede
revert: branch to master
realstealthninja Oct 10, 2024
e946aa6
Merge branch 'master' into doxygen-awesome
realstealthninja Nov 4, 2024
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
6 changes: 3 additions & 3 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Doxygen CI

on:
on:
push:
branches: [master]

Expand All @@ -15,7 +15,7 @@ jobs:
run: |
brew install graphviz ninja doxygen
- name: configure
run: cmake -G Ninja -B ./build -S .
run: cmake -G Ninja -Duse_libclang=ON -DCMAKE_CXX_COMPILER=clang++ -B ./build -S .
- name: build
run: cmake --build build -t doc
- name: gh-pages
Expand All @@ -28,7 +28,7 @@ jobs:
git config --global user.name "$GITHUB_ACTOR"
git config --global user.email "[email protected]"
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
rm -rf d* && rm *.html && rm *.svg && rm *.map && rm *.md5 && rm *.png && rm *.js && rm *.css
rm -rf d* && rm *.html && rm *.svg && rm *.map && rm *.md5 && rm *.png && rm *.js
git add .
cp -rp ./build/html/* . && rm -rf ./build && ls -lah
git add .
Expand Down
33 changes: 8 additions & 25 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.22)
project(Algorithms_in_C++
project(TheAlgorithms/C++
LANGUAGES CXX
VERSION 1.0.0
DESCRIPTION "Set of algorithms implemented in C++."
Expand Down Expand Up @@ -54,47 +54,30 @@ add_subdirectory(physics)

cmake_policy(SET CMP0054 NEW)
cmake_policy(SET CMP0057 NEW)

find_package(Doxygen OPTIONAL_COMPONENTS dot dia)
if(DOXYGEN_FOUND)
set(DOXYGEN_GENERATE_MAN NO)
set(DOXYGEN_USE_MATHJAX YES)
set(DOXYGEN_GENERATE_HTML YES)
# set(DOXYGEN_HTML_TIMESTAMP YES)
set(DOXYGEN_EXTRACT_STATIC YES)
set(DOXYGEN_INLINE_SOURCES YES)
set(DOXYGEN_CREATE_SUBDIRS YES)
set(DOXYGEN_EXTRACT_PRIVATE YES)
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_STRIP_CODE_COMMENTS NO)
set(DOXYGEN_EXT_LINKS_IN_WINDOW YES)
set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
set(DOXYGEN_EXCLUDE_PATTERNS */build/*)
set(DOXYGEN_ENABLE_PREPROCESSING YES)
set(DOXYGEN_CLANG_ASSISTED_PARSING YES)
set(DOXYGEN_FILE_PATTERNS *.cpp *.h *.hpp *.md)
set(DOXYGEN_MATHJAX_EXTENSIONS TeX/AMSmath TeX/AMSsymbols)
set(DOXYGEN_TAGFILES "doc/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/")
if(DOXYGEN_FOUND)
if(MSVC)
set(DOXYGEN_CPP_CLI_SUPPORT YES)
endif()
set(DOXYGEN_MATHJAX_RELPATH "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML")

if(Doxygen_dot_FOUND)
set(DOXYGEN_HAVE_DOT YES)
set(DOXYGEN_CALL_GRAPH YES)
set(DOXYGEN_INTERACTIVE_SVG YES)
set(DOXYGEN_DOT_IMAGE_FORMAT "svg")
endif()

if(OPENMP_FOUND)
set(DOXYGEN_PREDEFINED "_OPENMP=1")
endif()

if(GLUT_FOUND)
set(DOXYGEN_PREDEFINED ${DOXYGEN_PREDEFINED} "GLUT_FOUND=1")
endif()

doxygen_add_docs(
doc
${PROJECT_SOURCE_DIR}
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
COMMENT "Generate documentation"
CONFIG_FILE ${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile
)
endif()

Expand Down
Loading
Loading