Skip to content

Commit 8b1eab2

Browse files
doc: Use the doxygen awesome theme (#2807)
* chore: remove cppreference * feat: add doxyfile * feat: add doxygen-awesome theme * chore: remove unneccessary doxygen config form cmake * test: for doxygen test purposes Note: revert before merging to main * fix: try removing css from rm * fix: set style sheet via cmake * feat: make doxygen theme finally work * fix: remove mathjax from doxyfile * feat: add sidebar and make mathjax work * doc: add transparency and make output svg of dot * fix: make dots interactive * chore: move math jax from cmake to doxyfile * feat: add header file * chore: add header file to cmake * chore: remove redundant transparency config * fix: force cmake to use config file * chore: remove working directory * fix: use old add_docs command * feat: fix doxygen build * fix: re enable clang assited parsing * fix: use relative paths * fix: relative paths arent necessary * feat: add project logo and favicon * fix: revert gh-pages to master * fix: add dot to doxyfile * fix: add lib clang to doxygen * fix: use source browser * fix: add clang as compiler * docs: remove headers from source browser * revert: branch to master
1 parent 0d766b0 commit 8b1eab2

File tree

8 files changed

+5707
-35517
lines changed

8 files changed

+5707
-35517
lines changed

Diff for: .github/workflows/gh-pages.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Doxygen CI
22

3-
on:
3+
on:
44
push:
55
branches: [master]
66

@@ -15,7 +15,7 @@ jobs:
1515
run: |
1616
brew install graphviz ninja doxygen
1717
- name: configure
18-
run: cmake -G Ninja -B ./build -S .
18+
run: cmake -G Ninja -Duse_libclang=ON -DCMAKE_CXX_COMPILER=clang++ -B ./build -S .
1919
- name: build
2020
run: cmake --build build -t doc
2121
- name: gh-pages
@@ -28,7 +28,7 @@ jobs:
2828
git config --global user.name "$GITHUB_ACTOR"
2929
git config --global user.email "[email protected]"
3030
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
31-
rm -rf d* && rm *.html && rm *.svg && rm *.map && rm *.md5 && rm *.png && rm *.js && rm *.css
31+
rm -rf d* && rm *.html && rm *.svg && rm *.map && rm *.md5 && rm *.png && rm *.js
3232
git add .
3333
cp -rp ./build/html/* . && rm -rf ./build && ls -lah
3434
git add .

Diff for: CMakeLists.txt

+8-25
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cmake_minimum_required(VERSION 3.22)
2-
project(Algorithms_in_C++
2+
project(TheAlgorithms/C++
33
LANGUAGES CXX
44
VERSION 1.0.0
55
DESCRIPTION "Set of algorithms implemented in C++."
@@ -54,47 +54,30 @@ add_subdirectory(physics)
5454

5555
cmake_policy(SET CMP0054 NEW)
5656
cmake_policy(SET CMP0057 NEW)
57+
5758
find_package(Doxygen OPTIONAL_COMPONENTS dot dia)
58-
if(DOXYGEN_FOUND)
59-
set(DOXYGEN_GENERATE_MAN NO)
60-
set(DOXYGEN_USE_MATHJAX YES)
61-
set(DOXYGEN_GENERATE_HTML YES)
62-
# set(DOXYGEN_HTML_TIMESTAMP YES)
63-
set(DOXYGEN_EXTRACT_STATIC YES)
64-
set(DOXYGEN_INLINE_SOURCES YES)
65-
set(DOXYGEN_CREATE_SUBDIRS YES)
66-
set(DOXYGEN_EXTRACT_PRIVATE YES)
67-
set(DOXYGEN_GENERATE_TREEVIEW YES)
68-
set(DOXYGEN_STRIP_CODE_COMMENTS NO)
69-
set(DOXYGEN_EXT_LINKS_IN_WINDOW YES)
70-
set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
71-
set(DOXYGEN_EXCLUDE_PATTERNS */build/*)
72-
set(DOXYGEN_ENABLE_PREPROCESSING YES)
73-
set(DOXYGEN_CLANG_ASSISTED_PARSING YES)
74-
set(DOXYGEN_FILE_PATTERNS *.cpp *.h *.hpp *.md)
75-
set(DOXYGEN_MATHJAX_EXTENSIONS TeX/AMSmath TeX/AMSsymbols)
76-
set(DOXYGEN_TAGFILES "doc/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/")
59+
if(DOXYGEN_FOUND)
7760
if(MSVC)
7861
set(DOXYGEN_CPP_CLI_SUPPORT YES)
7962
endif()
80-
set(DOXYGEN_MATHJAX_RELPATH "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML")
63+
8164
if(Doxygen_dot_FOUND)
8265
set(DOXYGEN_HAVE_DOT YES)
83-
set(DOXYGEN_CALL_GRAPH YES)
84-
set(DOXYGEN_INTERACTIVE_SVG YES)
85-
set(DOXYGEN_DOT_IMAGE_FORMAT "svg")
8666
endif()
67+
8768
if(OPENMP_FOUND)
8869
set(DOXYGEN_PREDEFINED "_OPENMP=1")
8970
endif()
71+
9072
if(GLUT_FOUND)
9173
set(DOXYGEN_PREDEFINED ${DOXYGEN_PREDEFINED} "GLUT_FOUND=1")
9274
endif()
9375

9476
doxygen_add_docs(
9577
doc
96-
${PROJECT_SOURCE_DIR}
78+
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
9779
COMMENT "Generate documentation"
80+
CONFIG_FILE ${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile
9881
)
9982
endif()
10083

0 commit comments

Comments
 (0)