Skip to content

[WIP] try to get doxygen working #1696

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

Open
zingale wants to merge 4 commits into
base: development
Choose a base branch
from
Open

[WIP] try to get doxygen working #1696

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
539e41d
an attempt to get Doxygen working
zingale Jan 5, 2025
b168435
Fix breathe parsing errors
yut23 Jan 16, 2025
75a104f
Merge branch 'development' into doxygen_fixes
yut23 Jan 16, 2025
ca8644d
Merge branch 'development' into doxygen_fixes
zingale Jan 17, 2025
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
8 changes: 4 additions & 4 deletions sphinx_docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ LOOKUP_CACHE_SIZE = 0
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

EXTRACT_ALL = NO
EXTRACT_ALL = YES

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
Expand All @@ -443,7 +443,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down Expand Up @@ -780,7 +780,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../Source
INPUT = ../conductivity ../constants ../EOS ../integration ../interfaces ../networks ../neutrinos ../nse_solver ../nse_tabular ../opacity ../rates ../screening ../unit_test ../util

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -839,7 +839,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*

EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = util/autodiff/* util/gcem/* util/skynet/* */tmp_build_dir/*
Comment thread
yut23 marked this conversation as resolved.
Outdated

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
Expand Down
2 changes: 1 addition & 1 deletion sphinx_docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ clean:
html:
./rp.py > source/runtime_parameters.rst
doxygen Doxyfile
breathe-apidoc --o source doxy_files/xml
breathe-apidoc --o source doxy_files/xml -g class,file
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@if [ ! -d ../docs ]; then mkdir ../docs; fi

Expand Down
8 changes: 8 additions & 0 deletions sphinx_docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ of state routines.
comprehensive_tests
one_zone_tests

.. toctree::
:maxdepth: 1
:caption: API

filelist
classlist
.. namespacelist

.. toctree::
:maxdepth: 1
:caption: References
Expand Down