diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7728182a29..3d21914806 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -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) * Use ``CyclusBuildSetup`` macros to replace CMake boilerplate (#627) **Fixed:** diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 9c21d90b80..043983df9b 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -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 ${CYCLUS_CORE_SHARE_DIR}/doc/logo2_bike.gif) + SET(DOXYGEN_STYLESHEET_FILE ${CYCLUS_CORE_SHARE_DIR}/doc/doxygen-awesome.css) FIND_PACKAGE(HTMLHelp) diff --git a/doc/doxy.conf.in b/doc/doxy.conf.in index 4aa226f3de..3810d045d0 100644 --- a/doc/doxy.conf.in +++ b/doc/doxy.conf.in @@ -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 @@ -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 diff --git a/docker/Dockerfile b/docker/Dockerfile index 95774f4ef3..dace436979 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -2,7 +2,7 @@ ARG pkg_mgr=apt ARG ubuntu_version=22.04 ARG cyclus_tag=latest -FROM ghcr.io/cyclus/cyclus_${ubuntu_version}_${pkg_mgr}/cyclus:${cyclus_tag} as cycamore +FROM ghcr.io/cyclus/cyclus_${ubuntu_version}_${pkg_mgr}/cyclus:${cyclus_tag} AS cycamore ARG make_cores=2 COPY . /cycamore @@ -10,15 +10,15 @@ WORKDIR /cycamore RUN python3 install.py -j ${make_cores} --allow-milps -FROM cycamore as deb-generation +FROM cycamore AS deb-generation WORKDIR /cycamore/build RUN make package -FROM scratch as deb-package +FROM scratch AS deb-package COPY --from=deb-generation /cycamore/build/cycamore*.deb / -FROM cycamore as cycamore-test +FROM cycamore AS cycamore-test RUN cycamore_unit_tests -FROM cycamore-test as cycamore-pytest +FROM cycamore-test AS cycamore-pytest RUN cd tests && python3 -m pytest diff --git a/src/cycamore.h b/src/cycamore.h index a17995e402..c3ff0e8306 100644 --- a/src/cycamore.h +++ b/src/cycamore.h @@ -1,6 +1,17 @@ #ifndef CYCAMORE_SRC_CYCAMORE_H_ #define CYCAMORE_SRC_CYCAMORE_H_ +// For Doxygen mainpage +/*! + * \mainpage Cycamore API Reference + * + * Welcome to the Cycamore API reference! Below are some helpful links for learning more: + * - GitHub repository: https://github.com/cyclus/cycamore + * - Kernel developer guide: https://fuelcycle.org/kernel + * - Archetype developer guide: https://fuelcycle.org/arche + * + */ + // These includes must come before others. #include "cyclus.h" #include "cycamore_version.h"