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

Prettify Cycamore docs #626

Merged
merged 4 commits into from
Sep 22, 2024
Merged

Prettify Cycamore docs #626

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d39d99
add doxygen-awesome.css to doxygen build
bennibbelink Sep 19, 2024
9575e38
update CHANGELOG
bennibbelink Sep 19, 2024
3d50ad4
Merge branch 'main' into prettify-docs
bennibbelink Sep 20, 2024
390f3bc
find logo and stylesheet at cyclus_core_share_dir
bennibbelink Sep 21, 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
1 change: 1 addition & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Since last release
* Link against ``libxml++`` imported target in CMake instead of ``LIBXMLXX_LIBRARIES`` (#608)
* Cleaned up ``using`` declarations throughout archetypes (#610)
* Update archetype definitions to use cyclus constants instead of arbitrary hardcoded values (#606)
* Changed the styling of doxygen docs (#626)

**Fixed:**

Expand Down
2 changes: 2 additions & 0 deletions doc/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ IF(DOXYGEN_FOUND)
SET(DOXYGEN_SOURCE_DIR ${CYCAMORE_SOURCE_DIR})
SET(DOXYGEN_INPUT ${DOC_INPUT_DIR}/doxygen.conf)
SET(DOXYGEN_OUTPUT ${DOC_OUTPUT_DIR}/html/index.html)
SET(PROJECT_LOGO "${DOC_INPUT_DIR}/logo2_bike.gif")
SET(DOXYGEN_STYLESHEET_FILE "${DOC_INPUT_DIR}/doxygen-awesome.css")

FIND_PACKAGE(HTMLHelp)

Expand Down
8 changes: 6 additions & 2 deletions doc/doxy.conf.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ OUTPUT_LANGUAGE = @DOXYGEN_LANGUAGE@
INPUT_ENCODING =
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
HTML_EXTRA_STYLESHEET = @DOXYGEN_STYLESHEET_FILE@
PROJECT_LOGO = @PROJECT_LOGO@
GENERATE_TREEVIEW = YES
DISABLE_INDEX = NO
FULL_SIDEBAR = NO
HTML_COLORSTYLE = LIGHT
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
Expand Down Expand Up @@ -93,9 +99,7 @@ HHC_LOCATION = @HTML_HELP_COMPILER@
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
GENERATE_LATEX = @DOXYGEN_LATEX@
LATEX_OUTPUT = refman-latex
Expand Down
Loading
Loading